Schedules

Create Schedule

Schedule a pin for future publishing.

The pin will be published at the specified run_at time. The target board is preflighted at scheduling time so a board the account cannot publish to is rejected now rather than when the schedule fires.

post/v1/schedules

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
  • Auth: one of:
    • API key in header X-API-Key
    • HTTP bearer

Headers

x-api-keystring nullable
authorizationstring nullable

Request body

account_idstring uuid required

Pinterest account ID to publish with

run_atstring date-time required

When to publish this pin (ISO 8601 timestamp)

board_idstring required

Pinterest board ID

titlestring required

Pin title

descriptionstring nullable

Pin description

cover_image_urlstring uri nullable

Optional public cover image URL for scheduled video pins

cover_image_asset_idstring uuid nullable

Optional uploaded image asset ID used as a video cover image

link_urlstring uri nullable

Destination URL for the pin

image_urlstring uri nullable

Public URL of the image to pin

asset_idstring uuid nullable

Uploaded PinBridge asset ID to use for the scheduled image or video

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.