{
"opencollection": "1.0.0",
"info": {
"name": "Pinterest Bulk API",
"version": "5.13.0"
},
"items": [
{
"info": {
"name": "Bulk",
"type": "folder"
},
"items": [
{
"info": {
"name": "Get advertiser entities in bulk",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.pinterest.com/v5/ad_accounts/:ad_account_id/bulk/download",
"params": [
{
"name": "ad_account_id",
"value": "",
"type": "path",
"description": "Unique identifier of an ad account."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "https://www.pinterest.com/oauth/",
"accessTokenUrl": "https://api.pinterest.com/v5/oauth/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Create an asynchronous report that may include information on campaigns, ad groups, product groups, ads,\nand/or keywords; can filter by campaigns. Though the entities may be active, archived, or paused,\nonly active entities will return data."
},
{
"info": {
"name": "Create/update ad entities in bulk",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.pinterest.com/v5/ad_accounts/:ad_account_id/bulk/upsert",
"params": [
{
"name": "ad_account_id",
"value": "",
"type": "path",
"description": "Unique identifier of an ad account."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "https://www.pinterest.com/oauth/",
"accessTokenUrl": "https://api.pinterest.com/v5/oauth/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Either create or update any combination of campaigns, ad groups, product groups, ads, or keywords.\nNote that this request will be processed asynchronously; the response will include a request_id\nthat can be used to obtain the status of the request."
},
{
"info": {
"name": "Download advertiser entities in bulk",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.pinterest.com/v5/ad_accounts/:ad_account_id/bulk/:bulk_request_id",
"params": [
{
"name": "ad_account_id",
"value": "",
"type": "path",
"description": "Unique identifier of an ad account."
},
{
"name": "bulk_request_id",
"value": "",
"type": "path",
"description": "Unique identifier of a bulk upsert request."
},
{
"name": "include_details",
"value": "",
"type": "query",
"description": "if set to True then attach the errors/details to all the requests"
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "https://www.pinterest.com/oauth/",
"accessTokenUrl": "https://api.pinterest.com/v5/oauth/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Get the status of a bulk request by request_id, along with a download URL that will allow you to download the\nnew or updated entity data (campaigns, ad groups, product groups, ads, or keywords)."
}
]
}
],
"bundled": true
}