Pins

Update Pin

Edit a pin's title, description, link, alt text, or board before it publishes.

Queued, deferred and failed pins are edited in place and publish with the new values. A published pin cannot be edited: Pinterest's API does not let PinBridge change a pin once it is live, so the call returns 409 pin_already_published; delete the pin and publish a corrected one instead. Pins currently publishing return 409 pin_publishing. Both refusals are recorded in the activity log as pin.update_rejected. In a simulated sandbox board_id cannot change.

patch/v1/pins/{pin_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/pins/{pin_id}
  • Auth: one of:
    • API key in header X-API-Key
    • HTTP bearer

Path parameters

pin_idstring uuid required

Headers

x-api-keystring nullable
authorizationstring nullable

Request body

titlestring nullable

Pin title

descriptionstring nullable

Pin description

link_urlstring uri nullable

Destination URL for the pin

alt_textstring nullable

Alternative text used for accessibility

board_idstring nullable

Move the pin to another board

Response

Successful Response

idstring uuid required
workspace_idstring uuid required
pinterest_account_idstring uuid required
status'queued' | 'deferred' | 'publishing' | 'published' | 'failed' required

Pin status enum.

media_type'image' | 'video' required

Pin media type enum.

titlestring required
descriptionstring nullable
related_termsstring[] nullable
alt_textstring nullable
dominant_colorstring nullable
cover_image_urlstring nullable
link_urlstring nullable
media_urlstring required
image_urlstring required
asset_idstring uuid nullable
board_idstring required
pinterest_pin_idstring nullable
error_codestring nullable
error_messagestring nullable
idempotency_keystring required
created_atstring date-time required
updated_atstring date-time required
published_atstring date-time nullable
failed_atstring date-time nullable

When the pin failed; set only while status is failed and cleared by a retry, like error_code

removed_from_pinterest_atstring date-time nullable

When PinBridge found that this published pin no longer exists on Pinterest (deleted there by hand or with its board). The pin keeps status published; null means it is live or has not been checked.

Changes

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