Options for posting via the API to Pinterest
Pinterest requires an image to be included in the post. Other parameters are optional.
title
: The title of the pin to display. This appears in the "Add your title" section of a new pin. Maximum characters allowed: 100.link
: The clickthrough link URL when the image is clicked.boardId
: Post to another one of the user's Pinterest Boards by specifying the ID obtained from the /user/details endpoint. Otherwise post to the default linked board.
{
"post": "The best Pinterest API ever!",
"platforms": ["pinterest"],
"mediaUrls": ["https://images.ayrshare.com/imgs/GhostBusters.jpg"],
"pinterestOptions": {
"title": "A Pinterest Board for You", // optional
"link": "https://www.ayrshare.com", // optional
"boardId": "93383204522" // optional
}
}
A video may be posted as a Pin using the standard
mediaUrls
field in the /post endpoint. Additionally, a thumbnail image URL must be included with the video. Please see requirements."pinterestOptions": {
"thumbNail": "https://images.unsplash.com/photo-1513093496871-0a81425386e5?crop=entropy&cs=tinysrgb&fit=max&fm=jpg&ixid=MnwxNjQ1ODN8MHwxfHJhbmRvbXx8fHx8fHx8fDE2Mzg0ODAzNDA&ixlib=rb-1.2.1&q=80&w=400"
}
If your video doesn't end in a known video extension such as mp4, please use the
isVideo
parameter. See the /post endpoint for details.Add alternative text, also known as alt text, to a Pinterest image or video. Pinterest alt text is an accessibility feature used for additional user info and screen readers.
Use the
altText
in the pinterestOptions
object."pinterestOptions": {
"altText": "This is my best pic", "😃 here is the next one"
}
The alt text is limited to 500 characters.
Last modified 7mo ago