Skip to content

Pinterest settings

Every pin needs a board, which is the one required field.

Field Required Description
board Yes The numeric board id, digits only, not the board’s name.
title No The pin’s title, maximum 100 characters.
link No The pin’s destination URL. Must be a valid URL when present.
dominant_color No The pin’s dominant colour.
"settings": {
"board": "1234567890123456789",
"title": "Our new workspace",
"link": "https://example.com/workspace",
"dominant_color": "#B92D43"
}

board is an id rather than a name, so it has to be looked up per channel. Call trigger a channel tool with the board-listing tool that channel settings reports for the Pinterest channel.

Omitting board is refused with Board is required. An empty string, a board name, or any other value that is not all digits is refused with Board must be the numeric board id (use the boards list of the channel to find it), not the board name.

Every pin carries media, attached in image on the post’s first value entry: one to five items. A video pin takes exactly two, the video and one image that becomes its cover. Several images must all share the same width and height.