Docs
Pinterest

Overview

Connect Pinterest accounts, scopes, boards, and pin capabilities.

Onepostly maps the Pinterest API into the same /v1/* surface as other platforms. This section covers Pinterest-only behavior.

In this section

PageTopics
PostsCreate image / multi-image / video pins; board resolution; schedule; remote delete

Cross-platform API flow: Media, Webhooks.

Connect

  1. Dashboard → Connections → connect Pinterest
  2. Approve scopes in the Pinterest consent screen
  3. Resolve connectionId with your API key:
curl https://api.onepostly.com/v1/connections \
  -H "x-api-key: op_YOUR_KEY"

Use the matching row’s id (where platform is "pinterest") as connectionId.

After OAuth, connection metadata includes:

FieldMeaning
boards{ id, name }[] captured at connect time
defaultBoardIdPreferred board when destinations[].boardId is omitted
usernamePinterest username
sandboxtrue when connected in Sandbox

Boards API

Every pin must land on a board. You can manage boards explicitly:

List

curl https://api.onepostly.com/v1/connections/CONNECTION_ID/pinterest/boards \
  -H "x-api-key: op_YOUR_KEY"
{
  "connectionId": "…",
  "platform": "pinterest",
  "boards": [{ "id": "123", "name": "Recipes" }],
  "defaultBoardId": "123",
  "sandbox": true,
  "fetchedAt": "…"
}

Create

curl -X POST https://api.onepostly.com/v1/connections/CONNECTION_ID/pinterest/boards \
  -H "x-api-key: op_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "name": "Campaign Q3", "description": "Optional" }'

Sandbox note: boards on your normal Pinterest profile are production. Sandbox tokens only see boards created in Sandbox (or auto-created on publish).

OAuth scopes

ScopeUsed for
user_accounts:readProfile
boards:read / boards:writeList / create boards; pin targeting
pins:read / pins:writeCreate + delete pins

OAuth 2.0 authorization code.

Trial access and Sandbox

Pinterest Trial apps cannot create Pins in production. Use Sandbox while building and for the Standard-upgrade demo, then request Standard access.

Sandbox notes:

  • Image and multi-image pins work
  • Video pins are not supported in Sandbox
  • Pins/boards are only visible to the creator (sandbox entities)
  • After Standard approval, reconnect against production

Developer Portal setup

  1. Create an app on Pinterest Developers
  2. Add redirect URI: {API}/v1/connections/oauth/pinterest/callback
  3. Use Trial + Sandbox to build the Standard-upgrade demo, then request Standard access

Capabilities

ActionSupportedNotes
Create pinYesPOST /v1/posts
ImageYes
Multi-imageYes2–5 URLs
VideoYes (production)Not available in Sandbox
Text-only / stories / threadNo
ScheduleYesscheduledFor + timezone
BoardYesOptional boardId; auto-resolved when omitted
LinkYesOptional destination link
Remote deleteYesDELETE …/destinations/:id
Insights / commentsNo

Known limitations

  • Video pins may take time to finish processing on Pinterest before they appear.
  • Trial apps must use Sandbox until Standard access is approved.

See also