Update Sharing Settings

Control who can access your pinboard.

Endpoint


POST /v1/pinboards/:boardId/share

Authentication

Requires API key with pinboards:share scope.

Request Body

Field	Type	Required	Description
`is_public`	boolean	No	Make pinboard publicly accessible
`require_sign_in`	boolean	No	Require sign-in to view
`allow_comments`	boolean	No	Enable comments

Example

Client-JS


import { PindownClient } from '@pindownai/client-js'
 
const client = new PindownClient({
  apiKey: process.env.PINDOWN_API_KEY
})
 
// Make pinboard public
const result = await client.pinboards.share('pb-abc123', {
  is_public: true,
  allow_comments: true
})
 
console.log(`Share URL: ${result.shareable_url}`)
 
// Make private again
await client.pinboards.share('pb-abc123', {
  is_public: false
})

cURL


curl -X POST https://api.pindown.ai/v1/pinboards/pb-abc123/share \
  -H "Authorization: Bearer pk_live_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "is_public": true,
    "allow_comments": true
  }'

Node.js Fetch


const response = await fetch('https://api.pindown.ai/v1/pinboards/pb-abc123/share', {
  method: 'POST',
  headers: {
    'Authorization': `Bearer ${process.env.PINDOWN_API_KEY}`,
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    is_public: true,
    allow_comments: true
  })
})
 
const result = await response.json()
console.log('Pinboard shared successfully')

Response


{
  "success": true,
  "data": {
    "id": "pb-abc123",
    "is_public": true,
    "require_sign_in": false,
    "allow_comments": true
  }
}

Rate Limiting

This endpoint costs 3 tokens per request (email costs for notifications).