---
title: "Update board"
method: PATCH
path: "/boards/{board_id}"
tags: ["boards"]
---

# Update board

`PATCH /boards/{board_id}`

Update a board owned by the "operating user_account".
- Optional: Business Access: Specify an ad_account_id to use the owner of that ad_account as the "operation user_account".
- By default, the "operation user_account" is the token user_account.

## Path parameters

- `board_id` string, required

## Query parameters

- `ad_account_id` string

## Request body

- BoardUpdate — Board fields for updates
  - `name` string
  - `description` string, nullable
  - `privacy` 'PUBLIC' | 'SECRET'

## Response `200`

response

- Board — Board
  - `id` string
  - `created_at` string, date-time — Date and time of board creation.
  - `board_pins_modified_at` string, date-time — Date and time of last board pins modified.
  - `name` string, required — Name of the board. <strong>Note: </strong>If you create an ad-only board by setting `is_ads_only` to `true`, the board name automatically becomes "Ad-only Pins".
  - `description` string, nullable
  - `collaborator_count` integer — Count of collaborators on the board.
  - `pin_count` integer — Count of pins on the board.
  - `follower_count` integer — Board follower count.
  - `media` object — Board media.
    - `image_cover_url` string, nullable — Board cover image.
    - `pin_thumbnail_urls` string[] — Board pin thumbnail urls.
  - `owner` BoardOwner
    - `username` string
  - `privacy` 'PUBLIC' | 'PROTECTED' | 'SECRET' — Privacy setting for a board. Learn more about <a href="https://help.pinterest.com/en/article/secret-boards">secret boards</a> and <a href="https://help.pinterest.com/en/business/article/protected-boards">protected boards</a> <strong>Note: </strong>If you create an ad-only board by setting `is_ads_only` to `true`, the `privacy` settng automatically becomes `PROTECTED`.
  - `is_ads_only` boolean — If set to `true`, the board will be ad-only and can store ad-only Pins. You can only create one ad-only board for any client ID. If you attempt to create another, the system reuses the existing board rather than creating a new one.

## Other responses

- `400` — Invalid board parameters.
- `403` — Not authorized to update the board.
- `429` — This request exceeded a rate limit. This can happen if the client exceeds one of the published rate limits or if multiple write operations are applied to an object within a short time window.
- `default` — Unexpected error

## Changes

- **2025-07-16** (v5) `43134ca41f18` — 1 info
  - added the optional property `is_ads_only` to the response with the `200` status
- **2025-04-04** (v5) `10f9eba4ad97` — 1 info
  - the endpoint scheme security `client_credentials` was added to the API
- **2023-05-12** (v5) `689b4b267639` — 7 info
  - added the new optional `query` request parameter `ad_account_id`
  - added the optional property `board_pins_modified_at` to the response with the `200` status
  - added the optional property `collaborator_count` to the response with the `200` status
  - added the optional property `created_at` to the response with the `200` status
  - …3 more
- **2021-11-05** (v5) `8583f6373a80` — 2 breaking, 2 info
  - added the pattern `^\d+$` to the `path` request parameter `board_id`
  - the `owner` response's property type changed from no type to `object` for status `200`
  - added the non-success response with the status `400`
  - added the non-success response with the status `403`

[Change history](https://skmtc.dev/pinterest/apis/pinterest-rest-api/changes/boards/:board_id/patch.md)

---

[API](https://skmtc.dev/pinterest/apis/pinterest-rest-api.md) · [All operations](https://skmtc.dev/pinterest/apis/pinterest-rest-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/pinterest/pinterest-rest-api/revisions/7d64d863909a/schema)