Sign in

v29

latestOpenAPI 3.0.3MITraw.githubusercontent.com2026-06-042661,1122.5 MB
boards

Update board

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.
patch/boards/{board_id}

Path parameters

board_idstring required

Query parameters

ad_account_idstring

Unique identifier of an ad account.

Request body

descriptionstring nullable
namestring
Name of the board.

**Note:** If you create an ad-only board by setting `is_ads_only`
to `true`, the board name automatically becomes "Ad-only Pins".
privacy'PUBLIC' | 'SECRET'

Example request

{
  "description": "My favorite summer recipes",
  "name": "Summer recipes"
}

Response

The request has succeeded.

board_pins_modified_atstring date-time

Date and time of last board pins modified.

collaborator_countinteger

Count of collaborators on the board.

created_atstring date-time

Date and time of board creation.

descriptionstring nullable
follower_countinteger

Board follower count.

idstring required
is_ads_onlyboolean

If set to true, the board will be ad-only and can store ad-only Pins.

namestring required
Name of the board.

**Note:** If you create an ad-only board by setting `is_ads_only`
to `true`, the board name automatically becomes "Ad-only Pins".
pin_countinteger

Count of Pins on the board.

Example response

{
  "collaborator_count": 17,
  "description": "My favorite summer recipes",
  "follower_count": 13,
  "id": "549755885175",
  "is_ads_only": true,
  "media": {
    "image_cover_url": "https://i.pinimg.com/400x300/fd/cd/d5/fdcdd5a6d8a80824add0d054125cd957.jpg",
    "pin_thumbnail_urls": [
      "https://i.pinimg.com/150x150/b4/57/10/b45710f1ede96af55230f4b43935c4af.jpg",
      "https://i.pinimg.com/150x150/dd/ff/46/ddff4616e39c1935cd05738794fa860e.jpg",
      "https://i.pinimg.com/150x150/84/ac/59/84ac59b670ccb5b903dace480a98930c.jpg",
      "https://i.pinimg.com/150x150/4c/54/6f/4c546f521be85e30838fb742bfff6936.jpg"
    ]
  },
  "name": "Summer recipes",
  "pin_count": 5
}