Schedules

Update Schedule

Edit a pending schedule in place.

Change the publish time, board, title, description, link or media of a schedule that has not started publishing, keeping its id and history. The same checks as creating a schedule apply to the changed fields: run_at must be in the future, a new board is preflighted, and new media is resolved. Schedules that already started return 409; cancel and recreate, or edit the resulting pin instead.

patch/v1/schedules/{schedule_id}

Request

  • Base URL: https://api.pinbridge.io (the document declares no server; this is the origin it was published from)
  • URL: https://api.pinbridge.io/v1/schedules/{schedule_id}
  • Auth: one of:
    • API key in header X-API-Key
    • HTTP bearer

Path parameters

schedule_idstring uuid required

Headers

x-api-keystring nullable
authorizationstring nullable

Request body

run_atstring date-time nullable

New publish time (ISO 8601, with tz)

board_idstring nullable

Move the schedule to another board

titlestring nullable

Pin title

descriptionstring nullable

Pin description

link_urlstring uri nullable

Destination URL for the pin

image_urlstring uri nullable

Replace the media with a public URL

asset_idstring uuid nullable

Replace the media with an uploaded asset

cover_image_urlstring uri nullable

Video cover image URL

cover_image_asset_idstring uuid nullable

Video cover image asset ID

Response

Successful Response

idstring uuid required
workspace_idstring uuid required
pinterest_account_idstring uuid required
run_atstring date-time required
status'scheduled' | 'queued' | 'deferred' | 'running' | 'done' | 'failed' | 'canceled' required

Schedule status enum.

payloadobject required
last_errorstring nullable
pin_idstring uuid nullable
created_atstring date-time required
updated_atstring date-time required

Changes

No recorded changes to this operation across all 1 revision of this API.