Pins

Delete Pin

Delete a pin.

By default this removes the PinBridge record only and returns 204. Pass delete_from_pinterest=true to also delete the published pin on Pinterest, the proportionate fix for one wrong pin (deleting the board is not); that variant returns 200 with removed_from_pinterest so the outcome is visible.

delete/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

Query parameters

delete_from_pinterestboolean

Also remove the published pin from Pinterest. Without this flag only the PinBridge record is deleted and the pin stays live on Pinterest.

Headers

x-api-keystring nullable
authorizationstring nullable

Response

Returned instead of 204 when delete_from_pinterest=true, so the caller can see whether the Pinterest-side delete happened.

idstring uuid required
deletedtrue
removed_from_pinterestboolean required

True when the pin was deleted on Pinterest (or was already gone there)

pinterest_pin_idstring nullable
reasonstring nullable

Why nothing was removed upstream: not_published (no Pinterest pin id) or simulated_sandbox

Changes

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