pins

Update Pin

Update a pin owned by the "operating user_account".

<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.

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.

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
board_idstring

The board to which this Pin belongs.

board_section_idstring nullable

The board section to which this Pin belongs.

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>.

Example response

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

Changes