boards:readboards:writepins:readpins:writecreative_typecreative_typecreative_typecreative_typemedia_sourceis_standardfalseis_standardsource_typesmedia_sourceis_standardsource_typesmedia_sourcemedia_idupload_urlupload_parameterscurl --location --request POST 'https://api.pinterest.com/v5/media' \ --header 'Content-Type: application/json' \ --data-raw '{"media_type": "video"}'
upload_urlContent-Typemultipart/form-dataupload_parameters204 No Contentcurl --location --request POST 'https://pinterest-media-upload.s3-accelerate.amazonaws.com/' \ --form 'x-amz-date="20221012T154547Z"' \ --form 'x-amz-signature="{x-amz-signature}"' \ --form 'x-amz-security-token="{x-amz-security-token}"' \ --form 'x-amz-algorithm="AWS4-HMAC-SHA256"' \ --form 'key="uploads/17/4d/be/2:video:704109860400394553:5258848560742447767"' \ --form 'policy="{policy}"' \ --form 'x-amz-credential="{x-amz-credential}"' \ --form 'Content-Type="multipart/form-data"' \ --form 'file=@"/filePath/video_file.MOV"'
media_idcurl --location --request GET 'https://api.pinterest.com/v5/media/{media_id}'
media_sourcevideo_idimage urlmedia_idcurl --location --request POST 'https://api.pinterest.com/v5/pins' \ --header 'Content-Type: application/json' \ --data-raw '{ "title": "pin_title", "description": "Your description here", "board_id": "pinterest_board_id", "media_source": { "source_type": "video_id", "cover_image_url": "image.jpg", "media_id": "media_id" } }'
| Parameter | Description |
|---|---|
linkstring | The URL that users visit when they click the Pin image on the Pin page. |
account_idstring | Account that owns the Pin and, later, the ad based on the Pin. If you do not pass ad_account_idIf you do pass ad_account_id |
titlestring | The text that Pinterest users see below the Pin preview and the Pin page when users click the preview. |
decriptionstring | The Pin's descriptive text users read when they go to the Pin page. |
board_idstring | Unique identifier for the board that would include the Pin. If you create an ad-only Pin by setting is_removabletrue |
media_source.source_typestring | The media format for the Pin. The type you specify will cause additional parameters to be required, as indicated in the Pin create/update endpoints. In this example, the specified type is image_url |
media_source.urlstring Required for certain media source types, including image_url | The URL of the Pin image from the third-party website. |
media_source.is_standardboolean | Whether the image Pin is standard or simple. Only applies to certain media_source types, including image_urlFor a Pin that you want to promote as an idea ad, set to falseSet to trueRestricted |
is_removable | Set to trueWhen you make a Pin ad-only, you do not have to assign it to a board by passing a board_id |
{ "link": "https://{example.com}/", "title": "Tree", "description": "Tree photo", "media_source": { "source_type": "image_url", "url": "https://{url_path}/{image_file_name_with_extension}", "is_standard": true }, "is_removable": true }
| Parameter | Description |
|---|---|
has_been_promoted | Whether the Pin has been promoted ( truefalseIf you have not yet created an ad with the Pin, this value is false |
board_id | Identifier for board that the Pin has been added to. If you create an ad-only Pin without adding it to a specific board, it automatically is added to an Ad-only Pins board. So, the board_id |
id | Identifier for the Pin you created. You will pass this id |
media.media_type.images | Versions of the Pin in different dimensions as it is rendered in different locations, such as the thumbnail and the Pin's page. |
board_owner.username | Pinterest account user name of owner of the board that includes the Pin. If you create an ad-only Pin without adding it to a specific board, it automatically is added to an Ad-only Pins board, which you own. |
{ "has_been_promoted": false, "link": "https://www.pinterest.com/", "board_section_id": null, "alt_text": null, "product_tags": [], "title": "Tree", "dominant_color": null, "board_id": "123456123456123456", "is_standard": true, "note": "", "board_owner": { "username": "exampleuser" }, "media": { "media_type": "image", "images": { "150x150": { "width": 150, "height": 150, "url": "https://i.pinimg.com/150x150/70/95/a8/1234abcd1234abcd1234abcd1234abcd.jpg" }, "400x300": { "width": 400, "height": 300, "url": "https://i.pinimg.com/400x300/70/95/a8/1234abcd1234abcd1234abcd1234abcd.jpg" }, "600x": { "width": 402, "height": 536, "url": "https://i.pinimg.com/564x/70/95/a8/1234abcd1234abcd1234abcd1234abcd.jpg" }, "1200x": { "width": 402, "height": 536, "url": "https://i.pinimg.com/1200x/70/95/a8/1234abcd1234abcd1234abcd1234abcd.jpg" } } }, "is_removable": true, "id": "654321654321654321", "creative_type": "REGULAR", "description": "Tree photo", "created_at": "2025-05-21T01:13:01", "pin_metrics": null, "is_owner": true, "parent_pin_id": null }