{ "opencollection": "1.0.0", "info": { "name": "Pinterest Subscriptions API", "version": "5.13.0" }, "items": [ { "info": { "name": "Subscriptions", "type": "folder" }, "items": [ { "info": { "name": "Get lead ads subscriptions", "type": "http" }, "http": { "method": "GET", "url": "https://api.pinterest.com/v5/ad_accounts/:ad_account_id/leads/subscriptions", "params": [ { "name": "ad_account_id", "value": "", "type": "path", "description": "Unique identifier of an ad account." }, { "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": "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": "Get the advertiser's list of lead ads subscriptions.\n- Only requests for the OWNER or ADMIN of the ad_account will be allowed.\n\nThis endpoint is currently in beta and not available to all apps. Learn more." }, { "info": { "name": "Create lead ads subscription", "type": "http" }, "http": { "method": "POST", "url": "https://api.pinterest.com/v5/ad_accounts/:ad_account_id/leads/subscriptions", "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 a lead ads webhook subscription.\nSubscriptions allow Pinterest to deliver lead data from Ads Manager directly to the subscriber. Subscriptions can exist for a specific lead form or at ad account level. \n- Only requests for the OWNER or ADMIN of the ad_account will be allowed.\n- Advertisers can set up multiple integrations using ad_account_id + lead_form_id but only one integration per unique records.\n- For data security, egress lead data is encrypted with AES-256-GCM.\n\nThis endpoi" }, { "info": { "name": "Get lead ads subscription", "type": "http" }, "http": { "method": "GET", "url": "https://api.pinterest.com/v5/ad_accounts/:ad_account_id/leads/subscriptions/:subscription_id", "params": [ { "name": "ad_account_id", "value": "", "type": "path", "description": "Unique identifier of an ad account." }, { "name": "subscription_id", "value": "", "type": "path", "description": "Unique identifier of a subscription." } ], "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 specific lead ads subscription record.\n- Only requests for the OWNER or ADMIN of the ad_account will be allowed.\n\nThis endpoint is currently in beta and not available to all apps. Learn more." }, { "info": { "name": "Delete lead ads subscription", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.pinterest.com/v5/ad_accounts/:ad_account_id/leads/subscriptions/:subscription_id", "params": [ { "name": "ad_account_id", "value": "", "type": "path", "description": "Unique identifier of an ad account." }, { "name": "subscription_id", "value": "", "type": "path", "description": "Unique identifier of a subscription." } ], "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": "Delete an existing lead ads webhook subscription by ID.\n- Only requests for the OWNER or ADMIN of the ad_account will be allowed.\n\nThis endpoint is currently in beta and not available to all apps. Learn more." } ] } ], "bundled": true }