{ "opencollection": "1.0.0", "info": { "name": "Pinterest Customer API", "version": "5.13.0" }, "items": [ { "info": { "name": "Customer", "type": "folder" }, "items": [ { "info": { "name": "Get customer lists", "type": "http" }, "http": { "method": "GET", "url": "https://api.pinterest.com/v5/ad_accounts/:ad_account_id/customer_lists", "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": "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": "

Get a set of customer lists including id and name based on the filters provided.

\n

(Customer lists are a type of audience.) For more information, see\nAudience targeting\n or the Audiences\nsection of the ads management guide.

" }, { "info": { "name": "Create customer lists", "type": "http" }, "http": { "method": "POST", "url": "https://api.pinterest.com/v5/ad_accounts/:ad_account_id/customer_lists", "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 customer list from your records(hashed or plain-text email addresses, or hashed MAIDs or IDFAs).

\n

A customer list is one of the four types of Pinterest audiences: for more information, see Audience targeting\nor the Audiences section of the ads management guide.

\n

Please review our Append or remove records to/from an existing customer list. (A customer list is one of the four types of Pinterest audiences.)

\n

When you add records to an existing customer list, the system scans the additions for existing Pinterest\naccounts; those are the records that will be added to your CUSTOMER_LIST audience. Your original list of records\n to add will be deleted when the matching process is complete.

\n

For more information, see