Update Pinboard

Update pinboard title, description, tags, or settings.

Endpoint


PUT /v1/pinboards/:boardId

Authentication

Requires API key with pinboards:write scope.

Request Body

Field	Type	Required	Description
`title`	string	No	Pinboard title
`description`	string	No	Pinboard description
`tags`	string[]	No	Tags
`is_public`	boolean	No	Public visibility

Example

Client-JS


import { PindownClient } from '@pindownai/client-js'
 
const client = new PindownClient({
  apiKey: process.env.PINDOWN_API_KEY
})
 
// Update pinboard
await client.pinboards.update('pb-abc123', {
  title: 'Updated Sales Dashboard',
  tags: ['sales', 'q4', '2024']
})
 
console.log('Pinboard updated successfully')

cURL


curl -X PUT https://api.pindown.ai/v1/pinboards/pb-abc123 \
  -H "Authorization: Bearer pk_live_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "Updated Dashboard"
  }'

Node.js Fetch


const response = await fetch('https://api.pindown.ai/v1/pinboards/pb-abc123', {
  method: 'PUT',
  headers: {
    'Authorization': `Bearer ${process.env.PINDOWN_API_KEY}`,
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    title: 'Updated Dashboard'
  })
})
 
const result = await response.json()
console.log('Pinboard updated')

Response


{
  "success": true,
  "data": {
    "id": "pb-abc123",
    "updated_at": 1730476800000
  }
}

Rate Limiting

This endpoint costs 2 tokens per request.