Skip to Content
Pindown.ai is in early alpha - features may change
Pinboards APIUpdate Layout

Update Pinboard Layout

Update the entire layout configuration for desktop and/or mobile.

Endpoint

PUT /v1/pinboards/:boardId/layout

Authentication

Requires API key with pinboards:write scope.

Request Body

FieldTypeRequiredDescription
layoutobjectNoDesktop layout configuration
mobile_layoutobjectNoMobile layout configuration

Example

import { PindownClient } from '@pindownai/client-js' const client = new PindownClient({ apiKey: process.env.PINDOWN_API_KEY }) // Update layout await client.pinboards.updateLayout('pb-abc123', { layout: { 'p-pin1': { x: 0, y: 0, w: 2, h: 1 }, 'p-pin2': { x: 2, y: 0, w: 2, h: 2 } }, mobile_layout: { 'p-pin1': { x: 0, y: 0, w: 2, h: 1 }, 'p-pin2': { x: 0, y: 1, w: 2, h: 2 } } }) console.log('Layout updated successfully')

Response

{ "success": true }

Rate Limiting

This endpoint costs 2 tokens per request.