Add Pin to Page

Add an existing pin to a page. Pins appear on the page in the order they are added.

Endpoint


POST /v1/pages/:pageId/pins

Authentication

Requires API key with pages:write scope. You must be the page owner or an editor.


Authorization: Bearer pk_live_your_api_key

Path Parameters

Parameter	Type	Required	Description
`pageId`	string	Yes	Page ID (e.g., `pg-abc123`)

Request Body

Field	Type	Required	Description
`pin_id`	string	Yes	Pin ID to add (e.g., `p-xyz789`)

Example

Client-JS


import { PindownClient } from '@pindownai/client-js'
 
const client = new PindownClient({
  apiKey: process.env.PINDOWN_API_KEY
})
 
await client.pages.addPin('pg-abc123', {
  pin_id: 'p-xyz789'
})
 
console.log('Pin added to page')

cURL


curl -X POST https://api.pindown.ai/v1/pages/pg-abc123/pins \
  -H "Authorization: Bearer pk_live_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "pin_id": "p-xyz789"
  }'

Node.js Fetch


await fetch('https://api.pindown.ai/v1/pages/pg-abc123/pins', {
  method: 'POST',
  headers: {
    'Authorization': `Bearer ${process.env.PINDOWN_API_KEY}`,
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    pin_id: 'p-xyz789'
  })
})
 
console.log('Pin added to page')

Response


{
  "success": true,
  "message": "Pin added to page successfully"
}

Notes

Pins appear on the page in the order they are added (top to bottom)
The same pin can be added to multiple pages
Adding a pin to a page does not affect the pin itself

Next Steps

List Pins in Page - See all pins on a page
Remove Pin from Page - Remove a pin from a page
Get Page - View page with all pins