Batch Remove Pins from Pinboard

Remove multiple pins from a pinboard in a single request. This is more efficient than making individual DELETE requests.

Endpoint


DELETE /v1/pinboards/:pinboardId/pins/batch

Authentication

Requires API key with pinboards:write scope. You must be the owner or editor of the pinboard.


Authorization: Bearer pk_live_your_api_key

Path Parameters

Parameter	Type	Required	Description
`pinboardId`	string	Yes	Pinboard ID (e.g., `pb-abc123`)

Request Body

Field	Type	Required	Description
`pin_ids`	string[]	Yes	Array of pin IDs to remove (max 50)

Example

Client-JS


import { PindownClient } from '@pindownai/client-js'
 
const client = new PindownClient({
  apiKey: process.env.PINDOWN_API_KEY
})
 
const result = await client.pinboards.batchRemovePins('pb-abc123', [
  'p-pin1',
  'p-pin2',
  'p-pin3'
])
 
console.log(`Removed: ${result.removed.length}`)
console.log(`Failed: ${result.failed.length}`)

cURL


curl -X DELETE https://api.pindown.ai/v1/pinboards/pb-abc123/pins/batch \
  -H "Authorization: Bearer pk_live_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "pin_ids": ["p-pin1", "p-pin2", "p-pin3"]
  }'

Node.js Fetch


const response = await fetch('https://api.pindown.ai/v1/pinboards/pb-abc123/pins/batch', {
  method: 'DELETE',
  headers: {
    'Authorization': `Bearer ${process.env.PINDOWN_API_KEY}`,
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    pin_ids: ['p-pin1', 'p-pin2', 'p-pin3']
  })
})
 
const result = await response.json()
console.log(`Removed: ${result.data.removed.length}`)

Response


{
  "success": true,
  "data": {
    "removed": ["p-pin1", "p-pin2"],
    "failed": [
      {
        "id": "p-pin3",
        "error": "Pin not found on pinboard"
      }
    ]
  },
  "message": "Removed 2 pins"
}

Response Fields

removed: Array of pin IDs that were successfully removed
failed: Array of pins that failed to remove with error messages

Notes

Maximum 50 pins per batch request
Each pin is processed independently - if one fails, others still succeed
Removing a pin from a pinboard does not delete the pin itself
Pins are also removed from the pinboard’s layout if they were positioned

Next Steps

Batch Add Pins - Add multiple pins to a pinboard
Remove Pin - Remove a single pin from a pinboard