Pins

Validate Pin

Dry-run a pin request.

Runs the full acceptance path — account, media, cover image, board access, idempotency, billing, quota and Pinterest rate headroom — and reports each step. Returns the exact payload that would be published. Nothing is queued.

post/v1/pins/validate

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/validate
  • 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

board_idstring required

Pinterest board ID

titlestring required

Pin title

descriptionstring nullable

Pin description

related_termsstring[] nullable

Optional related terms for Pinterest

alt_textstring nullable

Alternative text used for accessibility

dominant_colorstring nullable

Dominant hex color of the pin media (for example #6E7874)

cover_image_urlstring uri nullable

Optional public cover image URL for 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 pin image or video

idempotency_keystring required

Idempotency key to prevent duplicate pins

Response

Validation outcome; nothing is written.

validboolean required

True when no check failed; nothing was written

dry_runtrue
resolvedobject nullable

The payload PinBridge would publish after resolving assets and boards

existing_pin_idstring uuid nullable

Set when the idempotency key already matches a pin in this workspace

headroomobject nullable

Current PinBridge quota and Pinterest rate headroom

Changes

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