Sign in
boards

Delete board

Delete a board owned by the "operation 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.
delete/boards/{board_id}

Path parameters

board_idstring required

Query parameters

ad_account_idstring

Unique identifier of an ad account.

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
}

Changes

Changed in 5 of the 29 revisions of this API.18

  • v5b698c180678a1See the full diff
    • ○

      added the success response with the status 200

      response-success-status-added

    This revision also has 182 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • v514c297539b643See the full diff
    • ○

      added the non-success response with the status 400

      response-non-success-status-added

    • ○

      added the non-success response with the status 401

      response-non-success-status-added

    • ○

      removed the non-success response with the status 409

      response-non-success-status-removed

    This revision also has 7 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • v5689b4b2676391See the full diff
    • ○

      added the new optional query request parameter ad_account_id

      new-optional-request-parameter

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • v5c561dee8c1371See the full diff
    • ○

      added the non-success response with the status 409

      response-non-success-status-added

  • v58583f6373a8012See the full diff
    • ▲

      added the pattern ^\d+$ to the path request parameter board_id

      request-parameter-pattern-added

    • ○

      added the non-success response with the status 403

      response-non-success-status-added

    • ○

      added the non-success response with the status 429

      response-non-success-status-added