pins

Create Pin

Create a Pin on a board or board section owned by the "operation user_account".

Note: If the current "operation user_account" (defined by the access token) has access to another user's Ad Accounts via Pinterest Business Access, you can modify your request to make use of the current operation_user_account's permissions to those Ad Accounts by including the ad_account_id in the path parameters for the request (e.g. .../?ad_account_id=12345&...).

  • This function is intended solely for publishing new content created by the user. If you are interested in saving content created by others to your Pinterest boards, sometimes called 'curated content', please use our <a href='/docs/add-ons/save-button'>Save button</a> instead. For more tips on creating fresh content for Pinterest, review our <a href='/docs/content/content-creation/'>Content App Solutions Guide</a>.

<strong><a href='/docs/content/content-creation/#Creating%20video%20Pins'>Learn more</a></strong> about video Pin creation.

post/pins

Query parameters

ad_account_idstring

Unique identifier of an ad account.

Request body

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

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

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

Response

Successful pin creation.

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