{
"opencollection": "1.0.0",
"info": {
"name": "Pinterest Promotions API",
"version": "5.13.0"
},
"items": [
{
"info": {
"name": "Promotions",
"type": "folder"
},
"items": [
{
"info": {
"name": "Get product group promotions",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.pinterest.com/v5/ad_accounts/:ad_account_id/product_group_promotions",
"params": [
{
"name": "ad_account_id",
"value": "",
"type": "path",
"description": "Unique identifier of an ad account."
},
{
"name": "product_group_promotion_ids",
"value": "",
"type": "query",
"description": "List of Product group promotion Ids."
},
{
"name": "entity_statuses",
"value": "",
"type": "query",
"description": "Entity status"
},
{
"name": "ad_group_id",
"value": "123123123",
"type": "query",
"description": "Ad group Id."
},
{
"name": "page_size",
"value": "",
"type": "query",
"description": "Maximum number of items to include in a single page of the response. See documentation on Pagination for more information."
},
{
"name": "order",
"value": "",
"type": "query",
"description": "The order in which to sort the items returned: ASCENDING or DESCENDING\nby ID. Note that higher-value IDs are associated with more-recently added\nitems."
},
{
"name": "bookmark",
"value": "",
"type": "query",
"description": "Cursor used to fetch the next page of items"
}
],
"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": "List existing product group promotions associated with an ad account.\n\nInclude either ad_group_id or product_group_promotion_ids in your request.\n\nNote: ad_group_ids and product_group_promotion_ids are mutually exclusive parameters.\nOnly provide one. If multiple options are provided, product_group_promotion_ids takes precedence over ad_group_ids. If none are provided, the endpoint returns an error."
},
{
"info": {
"name": "Create product group promotions",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.pinterest.com/v5/ad_accounts/:ad_account_id/product_group_promotions",
"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": "Add one or more product groups from your catalog to an existing ad group. (Product groups added to an ad group are a 'product group promotion.')"
},
{
"info": {
"name": "Update product group promotions",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://api.pinterest.com/v5/ad_accounts/:ad_account_id/product_group_promotions",
"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": "Update multiple existing Product Group Promotions (by product_group_id)"
},
{
"info": {
"name": "Get a product group promotion by id",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.pinterest.com/v5/ad_accounts/:ad_account_id/product_group_promotions/:product_group_promotion_id",
"params": [
{
"name": "ad_account_id",
"value": "",
"type": "path",
"description": "Unique identifier of an ad account."
},
{
"name": "product_group_promotion_id",
"value": "",
"type": "path",
"description": "Unique identifier of a product group promotion"
}
],
"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 a product group promotion by id"
}
]
}
],
"bundled": true
}