Sign in
pins

Update Pin

Update a pin owned by the "operating user_account".

  • By default, the "operation user_account" is the token user_account.

Optional: Business Access: Specify an <code>ad_account_id</code> (obtained via <a href='/docs/api/v5/#operation/ad_accounts/list'>List ad accounts</a>) to use the owner of that ad_account as the "operation user_account". In order to do this, the token user_account must have one of the following <a href="https://help.pinterest.com/en/business/article/share-and-manage-access-to-your-ad-accounts">Business Access</a> roles on the ad_account:

  • For Pins on public or protected boards: Owner, Admin, Analyst, Campaign Manager.
  • For Pins on secret boards: Owner, Admin.

<strong>This endpoint is currently in beta and not available to all apps. <a href='/docs/new/about-beta-access/'>Learn more</a>.</strong>

patch/pins/{pin_id}

Path parameters

pin_idstring required

Unique identifier of a Pin.

Query parameters

ad_account_idstring

Unique identifier of an ad account.

Request body

alt_textstring nullable

Pin's alternative text.

board_idstring nullable

The id of the board to move the Pin onto.

board_section_idstring nullable

<a href="https://help.pinterest.com/en/article/create-a-board-section">Board section</a> ID.

descriptionstring nullable

Pin description - 500 characters maximum.

linkstring nullable

URL viewer is taken to when they click pin.

titlestring nullable

The native pin title that creators explicitly prefer to display.

notestring nullable

Private note for this Pin. <a href="https://help.pinterest.com/en/article/add-notes-to-your-pins">Learn more</a>.

Example request

{
  "link": "https://www.pinterest.com/"
}

Response

response

idstring
created_atstring date-time
linkstring nullable
titlestring nullable
descriptionstring nullable
dominant_colorstring nullable

Dominant pin color. Hex number, e.g. "#6E7874".

alt_textstring nullable
creative_type'REGULAR' | 'VIDEO' | 'SHOPPING' | 'CAROUSEL' | 'MAX_VIDEO' | 'SHOP_THE_PIN' | 'COLLECTION' | 'IDEA' | 'SHOWCASE' | 'QUIZ'

Ad creative type enum. </p><strong>Note:</strong> SHOP_THE_PIN has been deprecated. Please use COLLECTION instead.

board_idstring

The board to which this Pin belongs.

board_section_idstring nullable

The board section to which this Pin belongs.

is_ownerboolean

Whether the "operation user_account" is the Pin owner.

parent_pin_idstring nullable

The source pin id if this pin was saved from another pin. <a href="https://help.pinterest.com/article/save-pins-on-pinterest">Learn more</a>.

is_standardboolean

Whether the Pin is standard or not. See documentation on <a href="https://developers.pinterest.com/docs/content/update/">Changes to Pin creation</a> for more information.

has_been_promotedboolean

Whether the Pin has been promoted or not.

notestring nullable

Private note for this Pin. <a href="https://help.pinterest.com/en/article/add-notes-to-your-pins">Learn more</a>.

Example response

{
  "id": "813744226420795884",
  "created_at": "2020-01-01T20:10:40-00:00",
  "link": "https://www.pinterest.com/",
  "dominant_color": "#6E7874",
  "creative_type": "REGULAR"
}

Changes