Update Page

Update a page’s metadata (title, tags, etc.).

Endpoint


PUT /v1/pages/:pageId

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
`metadata`	object	No	Page metadata to update

Metadata Object

Field	Type	Required	Description
`title`	string	No	New page title
`tags`	string[]	No	New tags array

Example

Client-JS


import { PindownClient } from '@pindownai/client-js'
 
const client = new PindownClient({
  apiKey: process.env.PINDOWN_API_KEY
})
 
const page = await client.pages.update('pg-abc123', {
  metadata: {
    title: 'Updated Report Title',
    tags: ['sales', 'monthly', 'updated']
  }
})
 
console.log(`Page updated: ${page.id}`)

cURL


curl -X PUT https://api.pindown.ai/v1/pages/pg-abc123 \
  -H "Authorization: Bearer pk_live_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "metadata": {
      "title": "Updated Report Title",
      "tags": ["sales", "monthly", "updated"]
    }
  }'

Node.js Fetch


const response = await fetch('https://api.pindown.ai/v1/pages/pg-abc123', {
  method: 'PUT',
  headers: {
    'Authorization': `Bearer ${process.env.PINDOWN_API_KEY}`,
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    metadata: {
      title: 'Updated Report Title',
      tags: ['sales', 'monthly', 'updated']
    }
  })
})
 
const result = await response.json()
console.log(`Page updated: ${result.data.id}`)

Response


{
  "success": true,
  "data": {
    "id": "pg-abc123",
    "updated_at": 1703123456789
  },
  "message": "Page updated successfully"
}

Next Steps

Get Page - Retrieve updated page
Delete Page - Remove a page