Pin to a Pinterest board

List a channel's boards, then create a pin with a destination link and alt text.

Scopes: channels:read, media:write, posts:write, posts:publish.

Pinterest requires every pin to target a board, so pin creation is a two-step flow: fetch the channel's boards, then create the pin with POST /v1/posts/pinterest.

1. List the channel's boards

curl https://api.nimply.io/v1/channels/223e4567-e89b-12d3-a456-426614174001/pinterest/boards \
  -H "Authorization: Bearer $NIMPLY_API_KEY"

[
  { "id": "1022106146619699999", "name": "Product inspiration", "privacy": "PUBLIC", "pinCount": 42 },
  { "id": "1022106146619700123", "name": "Launch assets", "privacy": "SECRET", "pinCount": 7 }
]

The channel must be a PINTEREST channel (from GET /v1/channels); any other type returns 400.

2. Create the pin

curl -X POST https://api.nimply.io/v1/posts/pinterest \
  -H "Authorization: Bearer $NIMPLY_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: pin-workspace-inspo-001" \
  -d '{
    "channelId": "223e4567-e89b-12d3-a456-426614174001",
    "boardId": "1022106146619699999",
    "mediaIds": ["c4d5e6f7-1a2b-4c3d-9e8f-0a1b2c3d4e5f"],
    "title": "Workspace inspiration",
    "content": "Our favorite desk setups this year.",
    "link": "https://example.com/blog/desk-setups",
    "altText": "A tidy desk with a laptop, plant, and warm lamp",
    "schedule": "next_slot"
  }'

{
  "id": "7a245d46-…",
  "channelId": "223e4567-e89b-12d3-a456-426614174001",
  "title": "Workspace inspiration",
  "contentType": "POST",
  "status": "SCHEDULED",
  "scheduledAt": "2026-07-17T09:00:00.000Z",
  "mediaIds": ["c4d5e6f7-1a2b-4c3d-9e8f-0a1b2c3d4e5f"]
}

Gotchas

boardId is required — a pin without a board cannot publish, so the API rejects it at request time.
Up to 5 images (a carousel) or 1 video per pin; media must be uploaded first via POST /v1/media.
link is where the pin sends people who click through (max 2048 characters); altText (max 500) is read by screen readers — both optional but strongly recommended.
Board ids are stable — cache them if you pin frequently, and re-fetch when the user adds boards in Pinterest.

Pin to a Pinterest board

1. List the channel's boards

2. Create the pin

Gotchas

On this page