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
| Page | Topics |
|---|---|
| Posts | Create image / multi-image / video pins; board resolution; schedule; remote delete |
Cross-platform API flow: Media, Webhooks.
Connect
- Dashboard → Connections → connect Pinterest
- Approve scopes in the Pinterest consent screen
- Resolve
connectionIdwith 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:
| Field | Meaning |
|---|---|
boards | { id, name }[] captured at connect time |
defaultBoardId | Preferred board when destinations[].boardId is omitted |
username | Pinterest username |
sandbox | true 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
| Scope | Used for |
|---|---|
user_accounts:read | Profile |
boards:read / boards:write | List / create boards; pin targeting |
pins:read / pins:write | Create + 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
- Create an app on Pinterest Developers
- Add redirect URI:
{API}/v1/connections/oauth/pinterest/callback - Use Trial + Sandbox to build the Standard-upgrade demo, then request Standard access
Capabilities
| Action | Supported | Notes |
|---|---|---|
| Create pin | Yes | POST /v1/posts |
| Image | Yes | |
| Multi-image | Yes | 2–5 URLs |
| Video | Yes (production) | Not available in Sandbox |
| Text-only / stories / thread | No | |
| Schedule | Yes | scheduledFor + timezone |
| Board | Yes | Optional boardId; auto-resolved when omitted |
| Link | Yes | Optional destination link |
| Remote delete | Yes | DELETE …/destinations/:id |
| Insights / comments | No |
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.