{ "opencollection": "1.0.0", "info": { "name": "TikTok API for Business — Marketing API", "version": "v1.3" }, "request": { "auth": { "type": "apikey", "key": "Access-Token", "value": "{{Access-Token}}", "placement": "header" } }, "items": [ { "info": { "name": "Ads Management", "type": "folder" }, "items": [ { "info": { "name": "Get the dynamic quota [Adgroup Quota](https://ads.tiktok.com/marketing_api/docs?id=1768463039162369)", "type": "http" }, "http": { "method": "GET", "url": "https://business-api.tiktok.com/open_api/v1.3/adgroup/quota/", "params": [ { "name": "advertiser_id", "value": "", "type": "query", "description": "Advertiser ID." }, { "name": "Access-Token", "value": "", "type": "query", "description": "Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)." } ] }, "docs": "Get the dynamic quota [Adgroup Quota](https://ads.tiktok.com/marketing_api/docs?id=1768463039162369)" } ] }, { "info": { "name": "Account Management", "type": "folder" }, "items": [ { "info": { "name": "Get ad account details. [Advertiser Info](https://business-api.tiktok.com/portal/docs?id=1739593083610113)", "type": "http" }, "http": { "method": "GET", "url": "https://business-api.tiktok.com/open_api/v1.3/advertiser/info/", "params": [ { "name": "advertiser_ids", "value": "", "type": "query" }, { "name": "fields", "value": "", "type": "query" }, { "name": "Access-Token", "value": "", "type": "query", "description": "Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)." } ] }, "docs": "Get ad account details. [Advertiser Info](https://business-api.tiktok.com/portal/docs?id=1739593083610113)" }, { "info": { "name": "Update an ad account. [Advertiser Update](https://business-api.tiktok.com/portal/docs?id=1739939050770434)", "type": "http" }, "http": { "method": "POST", "url": "https://business-api.tiktok.com/open_api/v1.3/advertiser/update/", "params": [ { "name": "Access-Token", "value": "", "type": "query", "description": "Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update an ad account. [Advertiser Update](https://business-api.tiktok.com/portal/docs?id=1739939050770434)" }, { "info": { "name": "Get the Pangle audience packages. [Pangle Audience Package Get](https://business-api.tiktok.com/portal/docs?id=1740040177229826)", "type": "http" }, "http": { "method": "GET", "url": "https://business-api.tiktok.com/open_api/v1.3/pangle_audience_package/get/", "params": [ { "name": "advertiser_id", "value": "", "type": "query" }, { "name": "Access-Token", "value": "", "type": "query", "description": "Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)." } ] }, "docs": "Get the Pangle audience packages. [Pangle Audience Package Get](https://business-api.tiktok.com/portal/docs?id=1740040177229826)" }, { "info": { "name": "Get the Pangle block list. [Pangle Block List Get](https://business-api.tiktok.com/portal/docs?id=1740039957181441)", "type": "http" }, "http": { "method": "GET", "url": "https://business-api.tiktok.com/open_api/v1.3/pangle_block_list/get/", "params": [ { "name": "advertiser_id", "value": "", "type": "query" }, { "name": "Access-Token", "value": "", "type": "query", "description": "Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)." } ] }, "docs": "Get the Pangle block list. [Pangle Block List Get](https://business-api.tiktok.com/portal/docs?id=1740039957181441)" }, { "info": { "name": "Update the Pangle block list. [Pangle Block List Update](https://business-api.tiktok.com/portal/docs?id=1740040139110466)", "type": "http" }, "http": { "method": "POST", "url": "https://business-api.tiktok.com/open_api/v1.3/pangle_block_list/update/", "params": [ { "name": "Access-Token", "value": "", "type": "query", "description": "Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update the Pangle block list. [Pangle Block List Update](https://business-api.tiktok.com/portal/docs?id=1740040139110466)" }, { "info": { "name": "Check the status of Terms. [Term Check](https://business-api.tiktok.com/portal/docs?id=1737192304571394)", "type": "http" }, "http": { "method": "GET", "url": "https://business-api.tiktok.com/open_api/v1.3/term/check/", "params": [ { "name": "advertiser_id", "value": "", "type": "query" }, { "name": "term_type", "value": "", "type": "query" }, { "name": "Access-Token", "value": "", "type": "query", "description": "Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)." } ] }, "docs": "Check the status of Terms. [Term Check](https://business-api.tiktok.com/portal/docs?id=1737192304571394)" }, { "info": { "name": "Sign Terms. [Term Confirm](https://business-api.tiktok.com/portal/docs?id=1737192284435457)", "type": "http" }, "http": { "method": "POST", "url": "https://business-api.tiktok.com/open_api/v1.3/term/confirm/", "params": [ { "name": "Access-Token", "value": "", "type": "query", "description": "Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Sign Terms. [Term Confirm](https://business-api.tiktok.com/portal/docs?id=1737192284435457)" }, { "info": { "name": "Get Terms. [Term Get](https://business-api.tiktok.com/portal/docs?id=1737191909315585)", "type": "http" }, "http": { "method": "GET", "url": "https://business-api.tiktok.com/open_api/v1.3/term/get/", "params": [ { "name": "advertiser_id", "value": "", "type": "query" }, { "name": "term_type", "value": "", "type": "query" }, { "name": "lang", "value": "", "type": "query" }, { "name": "Access-Token", "value": "", "type": "query", "description": "Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)." } ] }, "docs": "Get Terms. [Term Get](https://business-api.tiktok.com/portal/docs?id=1737191909315585)" } ] }, { "info": { "name": "APP Management", "type": "folder" }, "items": [ { "info": { "name": "Create an app. [APP Create](https://business-api.tiktok.com/portal/docs?id=1740859280958466)", "type": "http" }, "http": { "method": "POST", "url": "https://business-api.tiktok.com/open_api/v1.3/app/create/", "params": [ { "name": "Access-Token", "value": "", "type": "query", "description": "Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create an app. [APP Create](https://business-api.tiktok.com/portal/docs?id=1740859280958466)" }, { "info": { "name": "Get info of an app. [APP Info](https://business-api.tiktok.com/portal/docs?id=1740859272887297)", "type": "http" }, "http": { "method": "GET", "url": "https://business-api.tiktok.com/open_api/v1.3/app/info/", "params": [ { "name": "advertiser_id", "value": "", "type": "query" }, { "name": "app_id", "value": "", "type": "query" }, { "name": "Access-Token", "value": "", "type": "query", "description": "Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)." } ] }, "docs": "Get info of an app. [APP Info](https://business-api.tiktok.com/portal/docs?id=1740859272887297)" }, { "info": { "name": "Get the app list. [APP List](https://business-api.tiktok.com/portal/docs?id=1740859313270786)", "type": "http" }, "http": { "method": "GET", "url": "https://business-api.tiktok.com/open_api/v1.3/app/list/", "params": [ { "name": "advertiser_id", "value": "", "type": "query", "description": "Advertiser ID." }, { "name": "app_platform_ids", "value": "", "type": "query", "description": "List of app platform ID for filter purpose." }, { "name": "Access-Token", "value": "", "type": "query", "description": "Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)." } ] }, "docs": "Get the app list. [APP List](https://business-api.tiktok.com/portal/docs?id=1740859313270786)" }, { "info": { "name": "Get App Conversion Events. [App Optimization Event](https://business-api.tiktok.com/portal/docs?id=1740859338750977)", "type": "http" }, "http": { "method": "GET", "url": "https://business-api.tiktok.com/open_api/v1.3/app/optimization_event/", "params": [ { "name": "app_id", "value": "", "type": "query", "description": "Your App ID, obtained after successfully creating your app." }, { "name": "advertiser_id", "value": "", "type": "query", "description": "Advertiser ID" }, { "name": "placement", "value": "", "type": "query", "description": "The apps where you want to deliver your ads. Required when placement_type is PLACEMENT_TYPE_NORMAL, and ignored when placement_type is PLACEMENT_TYPE_AUTOMATIC. Note: Currently, we support PLACEMENT_TIKTOK, PLACEMENT_PANGLE and PLACEMENT_GLOBAL_APP_BUNDLE. Please don't select PLACEMENT_TOPBUZZ or PLACEMENT_HELO as your placements since they've been deprecated. For a full list of enum values, see Enumeration - Placement. For Product Sales campaigns (objective_type = PRODUCT_SALES), only TikTok placement (PLACEMENT_TIKTOK) is supported." }, { "name": "placement_type", "value": "", "type": "query", "description": "版位类型。 枚举值：PLACEMENT_TYPE_AUTOMATIC（自动版位）,PLACEMENT_TYPE_NORMAL （编辑版位）。 默认值: PLACEMENT_TYPE_NORMAL。" }, { "name": "optimization_goal", "value": "", "type": "query", "description": "Optimization goal. For enum values, see Enumeration-Optimization Goal for more" }, { "name": "objective", "value": "", "type": "query", "description": "Advertising Objective. For enum values, see Enumeration-Advertising Objective" }, { "name": "available_only", "value": "", "type": "query", "description": "Whether to return only available conversion events. The default value: True (only return available conversion events)" }, { "name": "is_skan", "value": "", "type": "query", "description": "Whether the app is using Skan features." }, { "name": "app_promotion_type", "value": "", "type": "query", "description": "App promotion type. Required when objective_type is APP_PROMOTION. Enum values: APP_INSTALL, APP_RETARGETING. Note: APP_INSTALL can be used in an iOS14 Dedicated Campaign, while APP_RETARGETING cannot be used." }, { "name": "Access-Token", "value": "", "type": "query", "description": "Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)." } ] }, "docs": "Get App Conversion Events. [App Optimization Event](https://business-api.tiktok.com/portal/docs?id=1740859338750977)" }, { "info": { "name": "Get App Retargeting Events. [App Optimization Event Retargeting](https://business-api.tiktok.com/portal/docs?id=1740859371033601)", "type": "http" }, "http": { "method": "GET", "url": "https://business-api.tiktok.com/open_api/v1.3/app/optimization_event/retargeting/", "params": [ { "name": "app_id", "value": "", "type": "query" }, { "name": "advertiser_id", "value": "", "type": "query" }, { "name": "Access-Token", "value": "", "type": "query", "description": "Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)." } ] }, "docs": "Get App Retargeting Events. [App Optimization Event Retargeting](https://business-api.tiktok.com/portal/docs?id=1740859371033601)" }, { "info": { "name": "Update an app. [APP Update](https://business-api.tiktok.com/portal/docs?id=1740859300069378)", "type": "http" }, "http": { "method": "POST", "url": "https://business-api.tiktok.com/open_api/v1.3/app/update/", "params": [ { "name": "Access-Token", "value": "", "type": "query", "description": "Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update an app. [APP Update](https://business-api.tiktok.com/portal/docs?id=1740859300069378)" } ] }, { "info": { "name": "Audience", "type": "folder" }, "items": [ { "info": { "name": "Get details of audience overlap. [Audience Insight Overlap](https://business-api.tiktok.com/portal/docs?id=1797023590780930)", "type": "http" }, "http": { "method": "GET", "url": "https://business-api.tiktok.com/open_api/v1.3/audience/insight/overlap/", "params": [ { "name": "advertiser_id", "value": "", "type": "query" }, { "name": "benchmark_custom_audience_id", "value": "", "type": "query" }, { "name": "comparison_custom_audience_ids", "value": "", "type": "query" }, { "name": "Access-Token", "value": "", "type": "query", "description": "Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)." } ] }, "docs": "Get details of audience overlap. [Audience Insight Overlap](https://business-api.tiktok.com/portal/docs?id=1797023590780930)" }, { "info": { "name": "Apply a shared custom audience [Dmp Custom_audience Apply](https://ads.tiktok.com/marketing_api/docs?id=1740245827044354)", "type": "http" }, "http": { "method": "POST", "url": "https://business-api.tiktok.com/open_api/v1.3/dmp/custom_audience/apply/", "params": [ { "name": "Access-Token", "value": "", "type": "query", "description": "Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Apply a shared custom audience [Dmp Custom_audience Apply](https://ads.tiktok.com/marketing_api/docs?id=1740245827044354)" }, { "info": { "name": "Get the latest application log of custom audiences [Dmp Custom_audience Apply Log](https://ads.tiktok.com/marketing_api/docs?id=1758615737388033)", "type": "http" }, "http": { "method": "GET", "url": "https://business-api.tiktok.com/open_api/v1.3/dmp/custom_audience/apply/log/", "params": [ { "name": "advertiser_id", "value": "", "type": "query", "description": "Advertiser ID." }, { "name": "custom_audience_ids", "value": "", "type": "query", "description": "A list of custom audience IDs. Note The advertiser must be the owner of the custom_audience_ids. Otherwise, an error will occur. You can use the is_creator field returned in /dmp/custom_audience/list/ and /dmp/custom_audience/get/ to check whether this advertiser is the owner of this audience." }, { "name": "page", "value": "", "type": "query", "description": "Current page number. Default value: 1." }, { "name": "page_size", "value": "", "type": "query", "description": "Page size. Default value: 10." }, { "name": "timezone", "value": "", "type": "query", "description": "The timezone of returned value. For enum values, see Appendix - Time Zone. If not specified, UTC will be used." }, { "name": "Access-Token", "value": "", "type": "query", "description": "Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)." } ] }, "docs": "Get the latest application log of custom audiences [Dmp Custom_audience Apply Log](https://ads.tiktok.com/marketing_api/docs?id=1758615737388033)" }, { "info": { "name": "Create an audience by file [Dmp Custom_audience Create](https://ads.tiktok.com/marketing_api/docs?id=1739940570793985)", "type": "http" }, "http": { "method": "POST", "url": "https://business-api.tiktok.com/open_api/v1.3/dmp/custom_audience/create/", "params": [ { "name": "Access-Token", "value": "", "type": "query", "description": "Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create an audience by file [Dmp Custom_audience Create](https://ads.tiktok.com/marketing_api/docs?id=1739940570793985)" }, { "info": { "name": "Delete audiences [Dmp Custom_audience Delete](https://business-api.tiktok.com/portal/docs?id=1739940539757569)", "type": "http" }, "http": { "method": "POST", "url": "https://business-api.tiktok.com/open_api/v1.3/dmp/custom_audience/delete/", "params": [ { "name": "Access-Token", "value": "", "type": "query", "description": "Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Delete audiences [Dmp Custom_audience Delete](https://business-api.tiktok.com/portal/docs?id=1739940539757569)" }, { "info": { "name": "Upload a data file [Dmp Custom_audience File Upload](https://business-api.tiktok.com/portal/docs?id=1739940567842818)", "type": "http" }, "http": { "method": "POST", "url": "https://business-api.tiktok.com/open_api/v1.3/dmp/custom_audience/file/upload/", "params": [ { "name": "Access-Token", "value": "", "type": "query", "description": "Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)." } ], "body": { "type": "multipart-form", "data": [ { "name": "advertiser_id", "type": "text", "value": "" }, { "name": "calculate_type", "type": "text", "value": "" }, { "name": "file", "type": "text", "value": "" }, { "name": "file_signature", "type": "text", "value": "" }, { "name": "name", "type": "text", "value": "" } ] } }, "docs": "Upload a data file [Dmp Custom_audience File Upload](https://business-api.tiktok.com/portal/docs?id=1739940567842818)" }, { "info": { "name": "Obtain the details of specified audiences [Dmp Custom_audience Get](https://business-api.tiktok.com/portal/docs?id=1739940507792385)", "type": "http" }, "http": { "method": "GET", "url": "https://business-api.tiktok.com/open_api/v1.3/dmp/custom_audience/get/", "params": [ { "name": "advertiser_id", "value": "", "type": "query", "description": "Advertiser ID." }, { "name": "custom_audience_ids", "value": "", "type": "query", "description": "A list of Audience IDs. Length range is [1, 100] ." }, { "name": "history_size", "value": "", "type": "query", "description": "The size of the history data which the user requests." }, { "name": "Access-Token", "value": "", "type": "query", "description": "Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)." } ] }, "docs": "Obtain the details of specified audiences [Dmp Custom_audience Get](https://business-api.tiktok.com/portal/docs?id=1739940507792385)" }, { "info": { "name": "Get all audiences [Dmp Custom_audience List](https://business-api.tiktok.com/portal/docs?id=1739940506015746)", "type": "http" }, "http": { "method": "GET", "url": "https://business-api.tiktok.com/open_api/v1.3/dmp/custom_audience/list/", "params": [ { "name": "advertiser_id", "value": "", "type": "query", "description": "Advertiser ID." }, { "name": "custom_audience_ids", "value": "", "type": "query", "description": "A list of Audience IDs. Length range is [1, 100]." }, { "name": "page", "value": "", "type": "query", "description": "Current page number. Default value: 1. Value range: ≥ 1." }, { "name": "page_size", "value": "", "type": "query", "description": "Page size. Defaults is 10. Value range: 1-100." }, { "name": "Access-Token", "value": "", "type": "query", "description": "Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)." } ] }, "docs": "Get all audiences [Dmp Custom_audience List](https://business-api.tiktok.com/portal/docs?id=1739940506015746)" }, { "info": { "name": "Create a lookalike audience [Dmp Custom_audience Lookalike Create](https://business-api.tiktok.com/portal/docs?id=1739940511844353)", "type": "http" }, "http": { "method": "POST", "url": "https://business-api.tiktok.com/open_api/v1.3/dmp/custom_audience/lookalike/create/", "params": [ { "name": "Access-Token", "value": "", "type": "query", "description": "Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a lookalike audience [Dmp Custom_audience Lookalike Create](https://business-api.tiktok.com/portal/docs?id=1739940511844353)" }, { "info": { "name": "Manually refresh a Lookalike Audience [Dmp Custom_audience Lookalike Update](https://ads.tiktok.com/marketing_api/docs?id=1758616888158209)", "type": "http" }, "http": { "method": "POST", "url": "https://business-api.tiktok.com/open_api/v1.3/dmp/custom_audience/lookalike/update/", "params": [ { "name": "Access-Token", "value": "", "type": "query", "description": "Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Manually refresh a Lookalike Audience [Dmp Custom_audience Lookalike Update](https://ads.tiktok.com/marketing_api/docs?id=1758616888158209)" }, { "info": { "name": "Create an audience by rules [Dmp Custom_audience Rule Create](https://business-api.tiktok.com/portal/docs?id=1739940509849601)", "type": "http" }, "http": { "method": "POST", "url": "https://business-api.tiktok.com/open_api/v1.3/dmp/custom_audience/rule/create/", "params": [ { "name": "Access-Token", "value": "", "type": "query", "description": "Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create an audience by rules [Dmp Custom_audience Rule Create](https://business-api.tiktok.com/portal/docs?id=1739940509849601)" }, { "info": { "name": "Share custom audiences with other advertisers [Dmp Custom_audience Share](https://business-api.tiktok.com/portal/docs?id=1740245803888706)", "type": "http" }, "http": { "method": "POST", "url": "https://business-api.tiktok.com/open_api/v1.3/dmp/custom_audience/share/", "params": [ { "name": "Access-Token", "value": "", "type": "query", "description": "Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Share custom audiences with other advertisers [Dmp Custom_audience Share](https://business-api.tiktok.com/portal/docs?id=1740245803888706)" }, { "info": { "name": "Stop sharing custom audiences with other advertisers [Dmp Custom_audience Share Cancel](https://business-api.tiktok.com/portal/docs?id=1740245829978113)", "type": "http" }, "http": { "method": "POST", "url": "https://business-api.tiktok.com/open_api/v1.3/dmp/custom_audience/share/cancel/", "params": [ { "name": "Access-Token", "value": "", "type": "query", "description": "Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Stop sharing custom audiences with other advertisers [Dmp Custom_audience Share Cancel](https://business-api.tiktok.com/portal/docs?id=1740245829978113)" }, { "info": { "name": "Get the sharing log of a custom audience [Dmp Custom_audience Share Log](https://ads.tiktok.com/marketing_api/docs?id=1740245827044354)", "type": "http" }, "http": { "method": "GET", "url": "https://business-api.tiktok.com/open_api/v1.3/dmp/custom_audience/share/log/", "params": [ { "name": "advertiser_id", "value": "", "type": "query", "description": "Advertiser ID." }, { "name": "custom_audience_id", "value": "", "type": "query", "description": "Custom audiences that you want to get sharing log for." }, { "name": "Access-Token", "value": "", "type": "query", "description": "Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)." } ] }, "docs": "Get the sharing log of a custom audience [Dmp Custom_audience Share Log](https://ads.tiktok.com/marketing_api/docs?id=1740245827044354)" }, { "info": { "name": "Update the details of an audience [Dmp Custom_audience Update](https://business-api.tiktok.com/portal/docs?id=1739940572667906)", "type": "http" }, "http": { "method": "POST", "url": "https://business-api.tiktok.com/open_api/v1.3/dmp/custom_audience/update/", "params": [ { "name": "Access-Token", "value": "", "type": "query", "description": "Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update the details of an audience [Dmp Custom_audience Update](https://business-api.tiktok.com/portal/docs?id=1739940572667906)" }, { "info": { "name": "Create a Saved Audience [Dmp Saved_audience Create](https://business-api.tiktok.com/portal/docs?id=1780154541898754)", "type": "http" }, "http": { "method": "POST", "url": "https://business-api.tiktok.com/open_api/v1.3/dmp/saved_audience/create/", "params": [ { "name": "Access-Token", "value": "", "type": "query", "description": "Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a Saved Audience [Dmp Saved_audience Create](https://business-api.tiktok.com/portal/docs?id=1780154541898754)" }, { "info": { "name": "Delete Saved Audiences [Dmp Saved_audience Delete](https://business-api.tiktok.com/portal/docs?id=1780154666312706)", "type": "http" }, "http": { "method": "POST", "url": "https://business-api.tiktok.com/open_api/v1.3/dmp/saved_audience/delete/", "params": [ { "name": "Access-Token", "value": "", "type": "query", "description": "Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Delete Saved Audiences [Dmp Saved_audience Delete](https://business-api.tiktok.com/portal/docs?id=1780154666312706)" }, { "info": { "name": "Get the details of Saved Audiences [Dmp Saved_audience List](https://business-api.tiktok.com/portal/docs?id=1780154619404290)", "type": "http" }, "http": { "method": "GET", "url": "https://business-api.tiktok.com/open_api/v1.3/dmp/saved_audience/list/", "params": [ { "name": "advertiser_id", "value": "", "type": "query", "description": "Advertiser ID." }, { "name": "saved_audience_ids", "value": "", "type": "query", "description": "IDs of Saved Audiences. Max size: 100. To create Saved Audiences and obtain the Saved Audience IDs, use /dmp/saved_audience/create/." }, { "name": "page", "value": "", "type": "query" }, { "name": "page_size", "value": "", "type": "query" }, { "name": "Access-Token", "value": "", "type": "query", "description": "Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)." } ] }, "docs": "Get the details of Saved Audiences [Dmp Saved_audience List](https://business-api.tiktok.com/portal/docs?id=1780154619404290)" } ] }, { "info": { "name": "BC", "type": "folder" }, "items": [ { "info": { "name": "Get the transaction records of a BC or ad accounts. [BC Account Transaction Get](https://business-api.tiktok.com/portal/docs?id=1792849810925569)", "type": "http" }, "http": { "method": "GET", "url": "https://business-api.tiktok.com/open_api/v1.3/bc/account/transaction/get/", "params": [ { "name": "bc_id", "value": "", "type": "query" }, { "name": "child_bc_id", "value": "", "type": "query" }, { "name": "transaction_level", "value": "", "type": "query" }, { "name": "filtering", "value": "", "type": "query" }, { "name": "page", "value": "", "type": "query" }, { "name": "page_size", "value": "", "type": "query" }, { "name": "Access-Token", "value": "", "type": "query", "description": "Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)." } ] }, "docs": "Get the transaction records of a BC or ad accounts. [BC Account Transaction Get](https://business-api.tiktok.com/portal/docs?id=1792849810925569)" }, { "info": { "name": "Delete assets. [BC Asset Admin Delete](https://business-api.tiktok.com/portal/docs?id=1739657251102722)", "type": "http" }, "http": { "method": "POST", "url": "https://business-api.tiktok.com/open_api/v1.3/bc/asset/admin/delete/", "params": [ { "name": "Access-Token", "value": "", "type": "query", "description": "Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Delete assets. [BC Asset Admin Delete](https://business-api.tiktok.com/portal/docs?id=1739657251102722)" }, { "info": { "name": "Get assets of a Business Center as admins. [BC Asset Admin Get](https://business-api.tiktok.com/portal/docs?id=1739433007779841)", "type": "http" }, "http": { "method": "GET", "url": "https://business-api.tiktok.com/open_api/v1.3/bc/asset/admin/get/", "params": [ { "name": "bc_id", "value": "", "type": "query" }, { "name": "child_bc_id", "value": "", "type": "query" }, { "name": "asset_type", "value": "", "type": "query" }, { "name": "filtering", "value": "", "type": "query" }, { "name": "page", "value": "", "type": "query" }, { "name": "page_size", "value": "", "type": "query" }, { "name": "Access-Token", "value": "", "type": "query", "description": "Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)." } ] }, "docs": "Get assets of a Business Center as admins. [BC Asset Admin Get](https://business-api.tiktok.com/portal/docs?id=1739433007779841)" }, { "info": { "name": "Assign assets to a user. [BC Asset Assign](https://business-api.tiktok.com/portal/docs?id=1739438211077121)", "type": "http" }, "http": { "method": "POST", "url": "https://business-api.tiktok.com/open_api/v1.3/bc/asset/assign/", "params": [ { "name": "Access-Token", "value": "", "type": "query", "description": "Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Assign assets to a user. [BC Asset Assign](https://business-api.tiktok.com/portal/docs?id=1739438211077121)" }, { "info": { "name": "Get assets of a Business Center. [BC Asset Get](https://business-api.tiktok.com/portal/docs?id=1739432717798401)", "type": "http" }, "http": { "method": "GET", "url": "https://business-api.tiktok.com/open_api/v1.3/bc/asset/get/", "params": [ { "name": "bc_id", "value": "", "type": "query" }, { "name": "asset_type", "value": "", "type": "query" }, { "name": "child_bc_id", "value": "", "type": "query" }, { "name": "filtering", "value": "", "type": "query" }, { "name": "page", "value": "", "type": "query" }, { "name": "page_size", "value": "", "type": "query" }, { "name": "Access-Token", "value": "", "type": "query", "description": "Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)." } ] }, "docs": "Get assets of a Business Center. [BC Asset Get](https://business-api.tiktok.com/portal/docs?id=1739432717798401)" }, { "info": { "name": "Get members by an asset. [BC Asset Member Get](https://business-api.tiktok.com/portal/docs?id=1739659558931458)", "type": "http" }, "http": { "method": "GET", "url": "https://business-api.tiktok.com/open_api/v1.3/bc/asset/member/get/", "params": [ { "name": "bc_id", "value": "", "type": "query" }, { "name": "asset_type", "value": "", "type": "query" }, { "name": "asset_id", "value": "", "type": "query" }, { "name": "filtering", "value": "", "type": "query" }, { "name": "page", "value": "", "type": "query" }, { "name": "page_size", "value": "", "type": "query" }, { "name": "Access-Token", "value": "", "type": "query", "description": "Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)." } ] }, "docs": "Get members by an asset. [BC Asset Member Get](https://business-api.tiktok.com/portal/docs?id=1739659558931458)" }, { "info": { "name": "Get partners by assets. [BC Asset Partner Get](https://business-api.tiktok.com/portal/docs?id=1739663268166722)", "type": "http" }, "http": { "method": "GET", "url": "https://business-api.tiktok.com/open_api/v1.3/bc/asset/partner/get/", "params": [ { "name": "bc_id", "value": "", "type": "query" }, { "name": "asset_type", "value": "", "type": "query" }, { "name": "asset_id", "value": "", "type": "query" }, { "name": "filtering", "value": "", "type": "query" }, { "name": "page", "value": "", "type": "query" }, { "name": "page_size", "value": "", "type": "query" }, { "name": "Access-Token", "value": "", "type": "query", "description": "Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)." } ] }, "docs": "Get partners by assets. [BC Asset Partner Get](https://business-api.tiktok.com/portal/docs?id=1739663268166722)" }, { "info": { "name": "Revoke the access to an asset from a user. [BC Asset Unassign](https://business-api.tiktok.com/portal/docs?id=1739448126749698)", "type": "http" }, "http": { "method": "POST", "url": "https://business-api.tiktok.com/open_api/v1.3/bc/asset/unassign/", "params": [ { "name": "Access-Token", "value": "", "type": "query", "description": "Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Revoke the access to an asset from a user. [BC Asset Unassign](https://business-api.tiktok.com/portal/docs?id=1739448126749698)" }, { "info": { "name": "Create an Asset Group in your Business Center. [BC Asset Group Create](https://business-api.tiktok.com/portal/docs?id=1749001658583105)", "type": "http" }, "http": { "method": "POST", "url": "https://business-api.tiktok.com/open_api/v1.3/bc/asset_group/create/", "params": [ { "name": "Access-Token", "value": "", "type": "query", "description": "Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create an Asset Group in your Business Center. [BC Asset Group Create](https://business-api.tiktok.com/portal/docs?id=1749001658583105)" }, { "info": { "name": "Remove members' access to an Asset Group. [BC Asset Group Delete](https://business-api.tiktok.com/portal/docs?id=1749001673406466)", "type": "http" }, "http": { "method": "POST", "url": "https://business-api.tiktok.com/open_api/v1.3/bc/asset_group/delete/", "params": [ { "name": "Access-Token", "value": "", "type": "query", "description": "Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Remove members' access to an Asset Group. [BC Asset Group Delete](https://business-api.tiktok.com/portal/docs?id=1749001673406466)" }, { "info": { "name": "Get the assets or members of an Asset Group in a Business Center. [BC Asset Group Get](https://business-api.tiktok.com/portal/docs?id=1749001669670913)", "type": "http" }, "http": { "method": "GET", "url": "https://business-api.tiktok.com/open_api/v1.3/bc/asset_group/get/", "params": [ { "name": "bc_id", "value": "", "type": "query" }, { "name": "asset_group_id", "value": "", "type": "query" }, { "name": "query_entity", "value": "", "type": "query" }, { "name": "filtering", "value": "", "type": "query" }, { "name": "page", "value": "", "type": "query" }, { "name": "page_size", "value": "", "type": "query" }, { "name": "Access-Token", "value": "", "type": "query", "description": "Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)." } ] }, "docs": "Get the assets or members of an Asset Group in a Business Center. [BC Asset Group Get](https://business-api.tiktok.com/portal/docs?id=1749001669670913)" }, { "info": { "name": "Get all Asset Groups in your Business Center. [BC Asset Group List](https://business-api.tiktok.com/portal/docs?id=1749001665910786)", "type": "http" }, "http": { "method": "GET", "url": "https://business-api.tiktok.com/open_api/v1.3/bc/asset_group/list/", "params": [ { "name": "bc_id", "value": "", "type": "query" }, { "name": "filtering", "value": "", "type": "query" }, { "name": "page", "value": "", "type": "query" }, { "name": "page_size", "value": "", "type": "query" }, { "name": "Access-Token", "value": "", "type": "query", "description": "Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)." } ] }, "docs": "Get all Asset Groups in your Business Center. [BC Asset Group List](https://business-api.tiktok.com/portal/docs?id=1749001665910786)" }, { "info": { "name": "Update assets, members or the name of an Asset Group. [BC Asset Group Update](https://business-api.tiktok.com/portal/docs?id=1749001662156801)", "type": "http" }, "http": { "method": "POST", "url": "https://business-api.tiktok.com/open_api/v1.3/bc/asset_group/update/", "params": [ { "name": "Access-Token", "value": "", "type": "query", "description": "Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update assets, members or the name of an Asset Group. [BC Asset Group Update](https://business-api.tiktok.com/portal/docs?id=1749001662156801)" }, { "info": { "name": "Get the balance of a Business Center. [BC Balance Get](https://business-api.tiktok.com/portal/docs?id=1739939128198145)", "type": "http" }, "http": { "method": "GET", "url": "https://business-api.tiktok.com/open_api/v1.3/bc/balance/get/", "params": [ { "name": "bc_id", "value": "", "type": "query" }, { "name": "child_bc_id", "value": "", "type": "query" }, { "name": "Access-Token", "value": "", "type": "query", "description": "Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)." } ] }, "docs": "Get the balance of a Business Center. [BC Balance Get](https://business-api.tiktok.com/portal/docs?id=1739939128198145)" }, { "info": { "name": "Create a billing group in a Business Center. [BC Billing Group Create](https://business-api.tiktok.com/portal/docs?id=1738947780033537)", "type": "http" }, "http": { "method": "POST", "url": "https://business-api.tiktok.com/open_api/v1.3/bc/billing_group/create/", "headers": [ { "name": "Access-Token", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a billing group in a Business Center. [BC Billing Group Create](https://business-api.tiktok.com/portal/docs?id=1738947780033537)" }, { "info": { "name": "Get all billing groups in a Business Center. [BC Billing Group Get](https://business-api.tiktok.com/portal/docs?id=1738944324279297)", "type": "http" }, "http": { "method": "GET", "url": "https://business-api.tiktok.com/open_api/v1.3/bc/billing_group/get/", "params": [ { "name": "bc_id", "value": "", "type": "query" }, { "name": "filtering", "value": "", "type": "query" }, { "name": "page", "value": "", "type": "query" }, { "name": "page_size", "value": "", "type": "query" }, { "name": "Access-Token", "value": "", "type": "query", "description": "Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)." } ] }, "docs": "Get all billing groups in a Business Center. [BC Billing Group Get](https://business-api.tiktok.com/portal/docs?id=1738944324279297)" }, { "info": { "name": "Update settings of a billing group. [BC Billing Group Update](https://business-api.tiktok.com/portal/docs?id=1738947843447809)", "type": "http" }, "http": { "method": "POST", "url": "https://business-api.tiktok.com/open_api/v1.3/bc/billing_group/update/", "params": [ { "name": "Access-Token", "value": "", "type": "query", "description": "Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update settings of a billing group. [BC Billing Group Update](https://business-api.tiktok.com/portal/docs?id=1738947843447809)" }, { "info": { "name": "Get Business Centers that you have access to. [BC Get](https://business-api.tiktok.com/portal/docs?id=1737115687501826)", "type": "http" }, "http": { "method": "GET", "url": "https://business-api.tiktok.com/open_api/v1.3/bc/get/", "params": [ { "name": "bc_id", "value": "", "type": "query" }, { "name": "scene", "value": "", "type": "query" }, { "name": "filtering", "value": "", "type": "query" }, { "name": "page", "value": "", "type": "query" }, { "name": "page_size", "value": "", "type": "query" }, { "name": "Access-Token", "value": "", "type": "query", "description": "Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)." } ] }, "docs": "Get Business Centers that you have access to. [BC Get](https://business-api.tiktok.com/portal/docs?id=1737115687501826)" }, { "info": { "name": "Finance Managers and Finance Analysts of a Business Center account can use this endpoint to get total unpaid amount of their Business Center accounts. [BC Invoice Unpaid Get](https://business-api.tiktok.com/portal/docs?id=1740295904843777)", "type": "http" }, "http": { "method": "GET", "url": "https://business-api.tiktok.com/open_api/v1.3/bc/invoice/unpaid/get/", "params": [ { "name": "bc_id", "value": "", "type": "query" }, { "name": "invoice_type", "value": "", "type": "query" }, { "name": "Access-Token", "value": "", "type": "query", "description": "Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)." } ] }, "docs": "Finance Managers and Finance Analysts of a Business Center account can use this endpoint to get total unpaid amount of their Business Center accounts. [BC Invoice Unpaid Get](https://business-api.tiktok.com/portal/docs?id=1740295904843777)" }, { "info": { "name": "Delete member. [BC Member Delete](https://business-api.tiktok.com/portal/docs?id=1739939482851329)", "type": "http" }, "http": { "method": "POST", "url": "https://business-api.tiktok.com/open_api/v1.3/bc/member/delete/", "params": [ { "name": "Access-Token", "value": "", "type": "query", "description": "Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Delete member. [BC Member Delete](https://business-api.tiktok.com/portal/docs?id=1739939482851329)" }, { "info": { "name": "Get BC members. [BC Member Get](https://business-api.tiktok.com/portal/docs?id=1739939404802049)", "type": "http" }, "http": { "method": "GET", "url": "https://business-api.tiktok.com/open_api/v1.3/bc/member/get/", "params": [ { "name": "bc_id", "value": "", "type": "query" }, { "name": "child_bc_id", "value": "", "type": "query" }, { "name": "filtering", "value": "", "type": "query" }, { "name": "page", "value": "", "type": "query" }, { "name": "page_size", "value": "", "type": "query" }, { "name": "Access-Token", "value": "", "type": "query", "description": "Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)." } ] }, "docs": "Get BC members. [BC Member Get](https://business-api.tiktok.com/portal/docs?id=1739939404802049)" }, { "info": { "name": "Invite members to BC. [BC Member Invite](https://business-api.tiktok.com/portal/docs?id=1739939455765505)", "type": "http" }, "http": { "method": "POST", "url": "https://business-api.tiktok.com/open_api/v1.3/bc/member/invite/", "params": [ { "name": "Access-Token", "value": "", "type": "query", "description": "Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Invite members to BC. [BC Member Invite](https://business-api.tiktok.com/portal/docs?id=1739939455765505)" }, { "info": { "name": "Update member information. [BC Member Update](https://business-api.tiktok.com/portal/docs?id=1739696704424961)", "type": "http" }, "http": { "method": "POST", "url": "https://business-api.tiktok.com/open_api/v1.3/bc/member/update/", "params": [ { "name": "Access-Token", "value": "", "type": "query", "description": "Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update member information. [BC Member Update](https://business-api.tiktok.com/portal/docs?id=1739696704424961)" }, { "info": { "name": "Add partner to Business Center. [BC Partner Add](https://business-api.tiktok.com/portal/docs?id=1739662756510721)", "type": "http" }, "http": { "method": "POST", "url": "https://business-api.tiktok.com/open_api/v1.3/bc/partner/add/", "params": [ { "name": "Access-Token", "value": "", "type": "query", "description": "Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Add partner to Business Center. [BC Partner Add](https://business-api.tiktok.com/portal/docs?id=1739662756510721)" }, { "info": { "name": "Cancel asset sharing. [BC Partner Asset Delete](https://business-api.tiktok.com/portal/docs?id=1739662800930817)", "type": "http" }, "http": { "method": "POST", "url": "https://business-api.tiktok.com/open_api/v1.3/bc/partner/asset/delete/", "params": [ { "name": "Access-Token", "value": "", "type": "query", "description": "Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Cancel asset sharing. [BC Partner Asset Delete](https://business-api.tiktok.com/portal/docs?id=1739662800930817)" }, { "info": { "name": "Get partner assets. [BC Partner Asset Get](https://business-api.tiktok.com/portal/docs?id=1739662828320769)", "type": "http" }, "http": { "method": "GET", "url": "https://business-api.tiktok.com/open_api/v1.3/bc/partner/asset/get/", "params": [ { "name": "bc_id", "value": "", "type": "query" }, { "name": "partner_id", "value": "", "type": "query" }, { "name": "asset_type", "value": "", "type": "query" }, { "name": "share_type", "value": "", "type": "query" }, { "name": "filtering", "value": "", "type": "query" }, { "name": "page", "value": "", "type": "query" }, { "name": "page_size", "value": "", "type": "query" }, { "name": "Access-Token", "value": "", "type": "query", "description": "Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)." } ] }, "docs": "Get partner assets. [BC Partner Asset Get](https://business-api.tiktok.com/portal/docs?id=1739662828320769)" }, { "info": { "name": "Delete partner. [BC Partner Delete](https://business-api.tiktok.com/portal/docs?id=1739662779301890)", "type": "http" }, "http": { "method": "POST", "url": "https://business-api.tiktok.com/open_api/v1.3/bc/partner/delete/", "params": [ { "name": "Access-Token", "value": "", "type": "query", "description": "Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Delete partner. [BC Partner Delete](https://business-api.tiktok.com/portal/docs?id=1739662779301890)" }, { "info": { "name": "Get partners. [BC Partner Get](https://business-api.tiktok.com/portal/docs?id=1739662727395330)", "type": "http" }, "http": { "method": "GET", "url": "https://business-api.tiktok.com/open_api/v1.3/bc/partner/get/", "params": [ { "name": "bc_id", "value": "", "type": "query" }, { "name": "page", "value": "", "type": "query" }, { "name": "page_size", "value": "", "type": "query" }, { "name": "filtering", "value": "", "type": "query" }, { "name": "Access-Token", "value": "", "type": "query", "description": "Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)." } ] }, "docs": "Get partners. [BC Partner Get](https://business-api.tiktok.com/portal/docs?id=1739662727395330)" }, { "info": { "name": "Use this endpoint to get a list of ad accounts that have been linked to the request pixel. [BC Pixel Link Get](https://business-api.tiktok.com/portal/docs?id=1753994966965249)", "type": "http" }, "http": { "method": "GET", "url": "https://business-api.tiktok.com/open_api/v1.3/bc/pixel/link/get/", "params": [ { "name": "bc_id", "value": "", "type": "query" }, { "name": "pixel_code", "value": "", "type": "query" }, { "name": "page", "value": "", "type": "query" }, { "name": "page_size", "value": "", "type": "query" }, { "name": "Access-Token", "value": "", "type": "query", "description": "Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)." } ] }, "docs": "Use this endpoint to get a list of ad accounts that have been linked to the request pixel. [BC Pixel Link Get](https://business-api.tiktok.com/portal/docs?id=1753994966965249)" }, { "info": { "name": "Use this endpoint to link and unlink pixel to advertiser accounts. [BC Pixel Link Update](https://business-api.tiktok.com/portal/docs?id=1753994950327297)", "type": "http" }, "http": { "method": "POST", "url": "https://business-api.tiktok.com/open_api/v1.3/bc/pixel/link/update/", "params": [ { "name": "Access-Token", "value": "", "type": "query", "description": "Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Use this endpoint to link and unlink pixel to advertiser accounts. [BC Pixel Link Update](https://business-api.tiktok.com/portal/docs?id=1753994950327297)" }, { "info": { "name": "Transfer Pixel from Advertiser to BC. [BC Pixel Transfer](https://business-api.tiktok.com/portal/docs?id=1753994928261122)", "type": "http" }, "http": { "method": "POST", "url": "https://business-api.tiktok.com/open_api/v1.3/bc/pixel/transfer/", "params": [ { "name": "Access-Token", "value": "", "type": "query", "description": "Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Transfer Pixel from Advertiser to BC. [BC Pixel Transfer](https://business-api.tiktok.com/portal/docs?id=1753994928261122)" }, { "info": { "name": "Get translaction records of a Business Center. [BC Transaction Get](https://business-api.tiktok.com/portal/docs?id=1739939140408322)", "type": "http" }, "http": { "method": "GET", "url": "https://business-api.tiktok.com/open_api/v1.3/bc/transaction/get/", "params": [ { "name": "bc_id", "value": "", "type": "query" }, { "name": "filtering", "value": "", "type": "query" }, { "name": "start_date", "value": "", "type": "query" }, { "name": "end_date", "value": "", "type": "query" }, { "name": "page", "value": "", "type": "query" }, { "name": "page_size", "value": "", "type": "query" }, { "name": "Access-Token", "value": "", "type": "query", "description": "Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)." } ] }, "docs": "Get translaction records of a Business Center. [BC Transaction Get](https://business-api.tiktok.com/portal/docs?id=1739939140408322)" }, { "info": { "name": "Process payments (recharge money to or deduct money from an ad account in a Business Center. [BC Transfer](https://business-api.tiktok.com/portal/docs?id=1739939095321601)", "type": "http" }, "http": { "method": "POST", "url": "https://business-api.tiktok.com/open_api/v1.3/bc/transfer/", "params": [ { "name": "Access-Token", "value": "", "type": "query", "description": "Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Process payments (recharge money to or deduct money from an ad account in a Business Center. [BC Transfer](https://business-api.tiktok.com/portal/docs?id=1739939095321601)" } ] }, { "info": { "name": "Default", "type": "folder" }, "items": [ { "info": { "name": "Bc Create", "type": "http" }, "http": { "method": "POST", "url": "https://business-api.tiktok.com/open_api/v1.3/bc/create/", "params": [ { "name": "Access-Token", "value": "", "type": "query", "description": "Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)." } ], "body": { "type": "json", "data": "{}" } } }, { "info": { "name": "Bc Image Upload", "type": "http" }, "http": { "method": "POST", "url": "https://business-api.tiktok.com/open_api/v1.3/bc/image/upload/", "params": [ { "name": "Access-Token", "value": "", "type": "query", "description": "Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)." } ], "body": { "type": "multipart-form", "data": [ { "name": "bc_id", "type": "text", "value": "" }, { "name": "image_file", "type": "text", "value": "" } ] } } }, { "info": { "name": "Bc Member Assign", "type": "http" }, "http": { "method": "POST", "url": "https://business-api.tiktok.com/open_api/v1.3/bc/member/assign/", "params": [ { "name": "Access-Token", "value": "", "type": "query", "description": "Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)." } ], "body": { "type": "json", "data": "{}" } } } ] }, { "info": { "name": "Comments", "type": "folder" }, "items": [ { "info": { "name": "Check if a list of words is blocked. [Blockedword Check](https://business-api.tiktok.com/portal/docs?id=1739029247961089)", "type": "http" }, "http": { "method": "GET", "url": "https://business-api.tiktok.com/open_api/v1.3/blockedword/check/", "params": [ { "name": "advertiser_id", "value": "", "type": "query" }, { "name": "blocked_words", "value": "", "type": "query" }, { "name": "Access-Token", "value": "", "type": "query", "description": "Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)." } ] }, "docs": "Check if a list of words is blocked. [Blockedword Check](https://business-api.tiktok.com/portal/docs?id=1739029247961089)" }, { "info": { "name": "Add words to the block list. [Blockedword Create](https://business-api.tiktok.com/portal/docs?id=1739029218470913)", "type": "http" }, "http": { "method": "POST", "url": "https://business-api.tiktok.com/open_api/v1.3/blockedword/create/", "params": [ { "name": "Access-Token", "value": "", "type": "query", "description": "Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Add words to the block list. [Blockedword Create](https://business-api.tiktok.com/portal/docs?id=1739029218470913)" }, { "info": { "name": "Delete one or more blocked words. [Blockedword Delete](https://business-api.tiktok.com/portal/docs?id=1739029277346817)", "type": "http" }, "http": { "method": "POST", "url": "https://business-api.tiktok.com/open_api/v1.3/blockedword/delete/", "params": [ { "name": "Access-Token", "value": "", "type": "query", "description": "Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Delete one or more blocked words. [Blockedword Delete](https://business-api.tiktok.com/portal/docs?id=1739029277346817)" }, { "info": { "name": "Get the list of blocked words for an ad account. [Blockedword List](https://business-api.tiktok.com/portal/docs?id=1739029260837889)", "type": "http" }, "http": { "method": "GET", "url": "https://business-api.tiktok.com/open_api/v1.3/blockedword/list/", "params": [ { "name": "advertiser_id", "value": "", "type": "query" }, { "name": "page_info", "value": "", "type": "query" }, { "name": "Access-Token", "value": "", "type": "query", "description": "Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)." } ] }, "docs": "Get the list of blocked words for an ad account. [Blockedword List](https://business-api.tiktok.com/portal/docs?id=1739029260837889)" }, { "info": { "name": "Check the status of the export task. [Blockedword Task Check](https://business-api.tiktok.com/portal/docs?id=1739029311687681)", "type": "http" }, "http": { "method": "GET", "url": "https://business-api.tiktok.com/open_api/v1.3/blockedword/task/check/", "params": [ { "name": "task_id", "value": "", "type": "query" }, { "name": "advertiser_id", "value": "", "type": "query" }, { "name": "Access-Token", "value": "", "type": "query", "description": "Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)." } ] }, "docs": "Check the status of the export task. [Blockedword Task Check](https://business-api.tiktok.com/portal/docs?id=1739029311687681)" }, { "info": { "name": "Create a task to export blocked words. [Blockedword Task Create](https://business-api.tiktok.com/portal/docs?id=1739029296119809)", "type": "http" }, "http": { "method": "POST", "url": "https://business-api.tiktok.com/open_api/v1.3/blockedword/task/create/", "params": [ { "name": "Access-Token", "value": "", "type": "query", "description": "Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a task to export blocked words. [Blockedword Task Create](https://business-api.tiktok.com/portal/docs?id=1739029296119809)" }, { "info": { "name": "Replace a blocked word with another word. [Blockedword Task Update](https://business-api.tiktok.com/portal/docs?id=1739029234526209)", "type": "http" }, "http": { "method": "POST", "url": "https://business-api.tiktok.com/open_api/v1.3/blockedword/update/", "params": [ { "name": "Access-Token", "value": "", "type": "query", "description": "Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Replace a blocked word with another word. [Blockedword Task Update](https://business-api.tiktok.com/portal/docs?id=1739029234526209)" }, { "info": { "name": "Delete comments. [Comment Delete](https://business-api.tiktok.com/portal/docs?id=1738957772267522)", "type": "http" }, "http": { "method": "POST", "url": "https://business-api.tiktok.com/open_api/v1.3/comment/delete/", "params": [ { "name": "Access-Token", "value": "", "type": "query", "description": "Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Delete comments. [Comment Delete](https://business-api.tiktok.com/portal/docs?id=1738957772267522)" }, { "info": { "name": "Get comments for your ads. [Comment List](https://business-api.tiktok.com/portal/docs?id=1738086301876225)", "type": "http" }, "http": { "method": "GET", "url": "https://business-api.tiktok.com/open_api/v1.3/comment/list/", "params": [ { "name": "advertiser_id", "value": "", "type": "query" }, { "name": "start_time", "value": "", "type": "query" }, { "name": "end_time", "value": "", "type": "query" }, { "name": "sort_field", "value": "", "type": "query" }, { "name": "sort_type", "value": "", "type": "query" }, { "name": "page", "value": "", "type": "query" }, { "name": "page_size", "value": "", "type": "query" }, { "name": "comment_type", "value": "", "type": "query" }, { "name": "comment_status", "value": "", "type": "query" }, { "name": "search_field", "value": "", "type": "query" }, { "name": "search_value", "value": "", "type": "query" }, { "name": "Access-Token", "value": "", "type": "query", "description": "Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)." } ] }, "docs": "Get comments for your ads. [Comment List](https://business-api.tiktok.com/portal/docs?id=1738086301876225)" }, { "info": { "name": "Reply to comments. [Comment Post](https://business-api.tiktok.com/portal/docs?id=1738957702411265)", "type": "http" }, "http": { "method": "POST", "url": "https://business-api.tiktok.com/open_api/v1.3/comment/post/", "params": [ { "name": "Access-Token", "value": "", "type": "query", "description": "Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Reply to comments. [Comment Post](https://business-api.tiktok.com/portal/docs?id=1738957702411265)" }, { "info": { "name": "Get related comments. [Comment Reference](https://business-api.tiktok.com/portal/docs?id=1738086824859650)", "type": "http" }, "http": { "method": "GET", "url": "https://business-api.tiktok.com/open_api/v1.3/comment/reference/", "params": [ { "name": "advertiser_id", "value": "", "type": "query" }, { "name": "comment_id", "value": "", "type": "query" }, { "name": "comment_type", "value": "", "type": "query" }, { "name": "original_comment_id", "value": "", "type": "query" }, { "name": "app", "value": "", "type": "query" }, { "name": "page", "value": "", "type": "query" }, { "name": "page_size", "value": "", "type": "query" }, { "name": "Access-Token", "value": "", "type": "query", "description": "Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)." } ] }, "docs": "Get related comments. [Comment Reference](https://business-api.tiktok.com/portal/docs?id=1738086824859650)" }, { "info": { "name": "Use this endpoint to change the status of a list of comments from public to hidden, or vice versa. [Comment Status Update](https://business-api.tiktok.com/portal/docs?id=1738086844585985)", "type": "http" }, "http": { "method": "POST", "url": "https://business-api.tiktok.com/open_api/v1.3/comment/status/update/", "params": [ { "name": "Access-Token", "value": "", "type": "query", "description": "Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Use this endpoint to change the status of a list of comments from public to hidden, or vice versa. [Comment Status Update](https://business-api.tiktok.com/portal/docs?id=1738086844585985)" }, { "info": { "name": "Get comment export status. [Comment Task Check](https://business-api.tiktok.com/portal/docs?id=1738088242659330)", "type": "http" }, "http": { "method": "GET", "url": "https://business-api.tiktok.com/open_api/v1.3/comment/task/check/", "params": [ { "name": "task_id", "value": "", "type": "query" }, { "name": "advertiser_id", "value": "", "type": "query" }, { "name": "source", "value": "", "type": "query" }, { "name": "Access-Token", "value": "", "type": "query", "description": "Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)." } ] }, "docs": "Get comment export status. [Comment Task Check](https://business-api.tiktok.com/portal/docs?id=1738088242659330)" }, { "info": { "name": "Create comment export task. [Comment Task Create](https://business-api.tiktok.com/portal/docs?id=1738088144215041)", "type": "http" }, "http": { "method": "POST", "url": "https://business-api.tiktok.com/open_api/v1.3/comment/task/create/", "params": [ { "name": "Access-Token", "value": "", "type": "query", "description": "Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create comment export task. [Comment Task Create](https://business-api.tiktok.com/portal/docs?id=1738088144215041)" } ] }, { "info": { "name": "Campaign Creation", "type": "folder" }, "items": [ { "info": { "name": "Create GMV Max campaign [Smart Plus GMV Max Campaign Create](https://business-api.tiktok.com/portal/docs?id=1822000988713089)", "type": "http" }, "http": { "method": "POST", "url": "https://business-api.tiktok.com/open_api/v1.3/campaign/gmv_max/create/", "params": [ { "name": "Access-Token", "value": "", "type": "query", "description": "Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create GMV Max campaign [Smart Plus GMV Max Campaign Create](https://business-api.tiktok.com/portal/docs?id=1822000988713089)" }, { "info": { "name": "Get GMV Max campaign info [Smart Plus GMV Max Campaign Info](https://business-api.tiktok.com/portal/docs?id=1822000968821762)", "type": "http" }, "http": { "method": "GET", "url": "https://business-api.tiktok.com/open_api/v1.3/campaign/gmv_max/info/", "params": [ { "name": "advertiser_id", "value": "", "type": "query" }, { "name": "campaign_id", "value": "", "type": "query" }, { "name": "Access-Token", "value": "", "type": "query", "description": "Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)." } ] }, "docs": "Get GMV Max campaign info [Smart Plus GMV Max Campaign Info](https://business-api.tiktok.com/portal/docs?id=1822000968821762)" }, { "info": { "name": "Create GMV Max session [Smart Plus GMV Max Session Create](https://business-api.tiktok.com/portal/docs?id=1835246967275522)", "type": "http" }, "http": { "method": "POST", "url": "https://business-api.tiktok.com/open_api/v1.3/campaign/gmv_max/session/create/", "params": [ { "name": "Access-Token", "value": "", "type": "query", "description": "Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create GMV Max session [Smart Plus GMV Max Session Create](https://business-api.tiktok.com/portal/docs?id=1835246967275522)" }, { "info": { "name": "Delete GMV Max session [Smart Plus GMV Max Session Delete](https://business-api.tiktok.com/portal/docs?id=1835246983475217)", "type": "http" }, "http": { "method": "POST", "url": "https://business-api.tiktok.com/open_api/v1.3/campaign/gmv_max/session/delete/", "params": [ { "name": "Access-Token", "value": "", "type": "query", "description": "Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Delete GMV Max session [Smart Plus GMV Max Session Delete](https://business-api.tiktok.com/portal/docs?id=1835246983475217)" }, { "info": { "name": "Get GMV Max session info [Smart Plus GMV Max Session Get](https://business-api.tiktok.com/portal/docs?id=1835247031331842)", "type": "http" }, "http": { "method": "GET", "url": "https://business-api.tiktok.com/open_api/v1.3/campaign/gmv_max/session/get/", "params": [ { "name": "advertiser_id", "value": "", "type": "query" }, { "name": "session_ids", "value": "", "type": "query" }, { "name": "Access-Token", "value": "", "type": "query", "description": "Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)." } ] }, "docs": "Get GMV Max session info [Smart Plus GMV Max Session Get](https://business-api.tiktok.com/portal/docs?id=1835247031331842)" }, { "info": { "name": "Get GMV Max session list [Smart Plus GMV Max Session List](https://business-api.tiktok.com/portal/docs?id=1835246996436162)", "type": "http" }, "http": { "method": "GET", "url": "https://business-api.tiktok.com/open_api/v1.3/campaign/gmv_max/session/list/", "params": [ { "name": "campaign_id", "value": "", "type": "query" }, { "name": "advertiser_id", "value": "", "type": "query" }, { "name": "Access-Token", "value": "", "type": "query", "description": "Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)." } ] }, "docs": "Get GMV Max session list [Smart Plus GMV Max Session List](https://business-api.tiktok.com/portal/docs?id=1835246996436162)" }, { "info": { "name": "Update GMV Max session [Smart Plus GMV Max Session Update](https://business-api.tiktok.com/portal/docs?id=1835247009119233)", "type": "http" }, "http": { "method": "POST", "url": "https://business-api.tiktok.com/open_api/v1.3/campaign/gmv_max/session/update/", "params": [ { "name": "Access-Token", "value": "", "type": "query", "description": "Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update GMV Max session [Smart Plus GMV Max Session Update](https://business-api.tiktok.com/portal/docs?id=1835247009119233)" }, { "info": { "name": "Update GMV Max campaign [Smart Plus GMV Max Campaign Update](https://business-api.tiktok.com/portal/docs?id=1822001009002497)", "type": "http" }, "http": { "method": "POST", "url": "https://business-api.tiktok.com/open_api/v1.3/campaign/gmv_max/update/", "params": [ { "name": "Access-Token", "value": "", "type": "query", "description": "Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update GMV Max campaign [Smart Plus GMV Max Campaign Update](https://business-api.tiktok.com/portal/docs?id=1822001009002497)" }, { "info": { "name": "Get GMV Max bid recommendation [Smart Plus GMV Max Bid Recommend](https://business-api.tiktok.com/portal/docs?id=1822001024720897)", "type": "http" }, "http": { "method": "GET", "url": "https://business-api.tiktok.com/open_api/v1.3/gmv_max/bid/recommend/", "params": [ { "name": "advertiser_id", "value": "", "type": "query" }, { "name": "store_id", "value": "", "type": "query" }, { "name": "shopping_ads_type", "value": "", "type": "query" }, { "name": "optimization_goal", "value": "", "type": "query" }, { "name": "item_group_ids", "value": "", "type": "query" }, { "name": "identity_id", "value": "", "type": "query" }, { "name": "Access-Token", "value": "", "type": "query", "description": "Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)." } ] }, "docs": "Get GMV Max bid recommendation [Smart Plus GMV Max Bid Recommend](https://business-api.tiktok.com/portal/docs?id=1822001024720897)" }, { "info": { "name": "Get GMV Max custom anchor video list [Smart Plus GMV Max Custom Anchor Video List Get](https://business-api.tiktok.com/portal/docs?id=1830215925061633)", "type": "http" }, "http": { "method": "GET", "url": "https://business-api.tiktok.com/open_api/v1.3/gmv_max/custom_anchor_video_list/get/", "params": [ { "name": "advertiser_id", "value": "", "type": "query" }, { "name": "campaign_custom_anchor_video_id", "value": "", "type": "query" }, { "name": "custom_anchor_video_list", "value": "", "type": "query" }, { "name": "Access-Token", "value": "", "type": "query", "description": "Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)." } ] }, "docs": "Get GMV Max custom anchor video list [Smart Plus GMV Max Custom Anchor Video List Get](https://business-api.tiktok.com/portal/docs?id=1830215925061633)" }, { "info": { "name": "Get GMV Max occupied custom shop ads [Smart Plus GMV Max Occupied Custom Shop Ads List](https://business-api.tiktok.com/portal/docs?id=1822001136924674)", "type": "http" }, "http": { "method": "GET", "url": "https://business-api.tiktok.com/open_api/v1.3/gmv_max/occupied_custom_shop_ads/list/", "params": [ { "name": "advertiser_id", "value": "", "type": "query" }, { "name": "store_id", "value": "", "type": "query" }, { "name": "asset_ids", "value": "", "type": "query" }, { "name": "occupied_asset_type", "value": "", "type": "query" }, { "name": "Access-Token", "value": "", "type": "query", "description": "Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)." } ] }, "docs": "Get GMV Max occupied custom shop ads [Smart Plus GMV Max Occupied Custom Shop Ads List](https://business-api.tiktok.com/portal/docs?id=1822001136924674)" }, { "info": { "name": "Create a new campaign [Smart Plus Campaign Create]", "type": "http" }, "http": { "method": "POST", "url": "https://business-api.tiktok.com/open_api/v1.3/smart_plus/campaign/create/", "params": [ { "name": "Access-Token", "value": "", "type": "query", "description": "Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a new campaign [Smart Plus Campaign Create]" }, { "info": { "name": "Retrieve campaign details [Smart Plus Campaign Get]", "type": "http" }, "http": { "method": "GET", "url": "https://business-api.tiktok.com/open_api/v1.3/smart_plus/campaign/get/", "params": [ { "name": "advertiser_id", "value": "", "type": "query" }, { "name": "fields", "value": "", "type": "query" }, { "name": "filtering", "value": "", "type": "query" }, { "name": "page", "value": "", "type": "query" }, { "name": "page_size", "value": "", "type": "query" }, { "name": "Access-Token", "value": "", "type": "query", "description": "Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)." } ] }, "docs": "Retrieve campaign details [Smart Plus Campaign Get]" }, { "info": { "name": "Update campaign status [Smart Plus Campaign Status Update]", "type": "http" }, "http": { "method": "POST", "url": "https://business-api.tiktok.com/open_api/v1.3/smart_plus/campaign/status/update/", "params": [ { "name": "Access-Token", "value": "", "type": "query", "description": "Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update campaign status [Smart Plus Campaign Status Update]" }, { "info": { "name": "Update an existing campaign [Smart Plus Campaign Update]", "type": "http" }, "http": { "method": "POST", "url": "https://business-api.tiktok.com/open_api/v1.3/smart_plus/campaign/update/", "params": [ { "name": "Access-Token", "value": "", "type": "query", "description": "Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update an existing campaign [Smart Plus Campaign Update]" } ] }, { "info": { "name": "Catalog", "type": "folder" }, "items": [ { "info": { "name": "Get the countries and regions that ads for a catalog can be delivered to. [Catalog Available Country Get](https://business-api.tiktok.com/portal/docs?id=1740491257516034)", "type": "http" }, "http": { "method": "GET", "url": "https://business-api.tiktok.com/open_api/v1.3/catalog/available_country/get/", "params": [ { "name": "bc_id", "value": "", "type": "query" }, { "name": "Access-Token", "value": "", "type": "query", "description": "Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)." } ] }, "docs": "Get the countries and regions that ads for a catalog can be delivered to. [Catalog Available Country Get](https://business-api.tiktok.com/portal/docs?id=1740491257516034)" }, { "info": { "name": "Migrate catalogs under your ad account to your Business Center. [Catalog Capitalize](https://business-api.tiktok.com/portal/docs?id=1740490222539778)", "type": "http" }, "http": { "method": "POST", "url": "https://business-api.tiktok.com/open_api/v1.3/catalog/capitalize/", "params": [ { "name": "Access-Token", "value": "", "type": "query", "description": "Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Migrate catalogs under your ad account to your Business Center. [Catalog Capitalize](https://business-api.tiktok.com/portal/docs?id=1740490222539778)" }, { "info": { "name": "Create a catalog by specifying information such as name, targeted locations, and currency. [Catalog Create](https://business-api.tiktok.com/portal/docs?id=1740306481704961)", "type": "http" }, "http": { "method": "POST", "url": "https://business-api.tiktok.com/open_api/v1.3/catalog/create/", "params": [ { "name": "Access-Token", "value": "", "type": "query", "description": "Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a catalog by specifying information such as name, targeted locations, and currency. [Catalog Create](https://business-api.tiktok.com/portal/docs?id=1740306481704961)" }, { "info": { "name": "Delete a catalog. [Catalog Delete](https://business-api.tiktok.com/portal/docs?id=1740310064588801)", "type": "http" }, "http": { "method": "POST", "url": "https://business-api.tiktok.com/open_api/v1.3/catalog/delete/", "params": [ { "name": "Access-Token", "value": "", "type": "query", "description": "Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Delete a catalog. [Catalog Delete](https://business-api.tiktok.com/portal/docs?id=1740310064588801)" }, { "info": { "name": "Bind app or website event sources to a catalog in a Business Center. [Catalog Eventsource Bind](https://business-api.tiktok.com/portal/docs?id=1740492491200513)", "type": "http" }, "http": { "method": "POST", "url": "https://business-api.tiktok.com/open_api/v1.3/catalog/eventsource/bind/", "params": [ { "name": "Access-Token", "value": "", "type": "query", "description": "Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Bind app or website event sources to a catalog in a Business Center. [Catalog Eventsource Bind](https://business-api.tiktok.com/portal/docs?id=1740492491200513)" }, { "info": { "name": "Unbind event sources from a catalog. [Catalog Eventsource Unbind](https://business-api.tiktok.com/portal/docs?id=1740492512449538)", "type": "http" }, "http": { "method": "POST", "url": "https://business-api.tiktok.com/open_api/v1.3/catalog/eventsource/unbind/", "params": [ { "name": "Access-Token", "value": "", "type": "query", "description": "Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Unbind event sources from a catalog. [Catalog Eventsource Unbind](https://business-api.tiktok.com/portal/docs?id=1740492512449538)" }, { "info": { "name": "Get event source binding information. [Catalog Eventsource Bind Get](https://business-api.tiktok.com/portal/docs?id=1740492531343362)", "type": "http" }, "http": { "method": "GET", "url": "https://business-api.tiktok.com/open_api/v1.3/catalog/eventsource_bind/get/", "params": [ { "name": "catalog_id", "value": "", "type": "query" }, { "name": "bc_id", "value": "", "type": "query" }, { "name": "Access-Token", "value": "", "type": "query", "description": "Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)." } ] }, "docs": "Get event source binding information. [Catalog Eventsource Bind Get](https://business-api.tiktok.com/portal/docs?id=1740492531343362)" }, { "info": { "name": "Create a feed. [Catalog Feed Create](https://business-api.tiktok.com/portal/docs?id=1740665161957377)", "type": "http" }, "http": { "method": "POST", "url": "https://business-api.tiktok.com/open_api/v1.3/catalog/feed/create/", "params": [ { "name": "Access-Token", "value": "", "type": "query", "description": "Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a feed. [Catalog Feed Create](https://business-api.tiktok.com/portal/docs?id=1740665161957377)" }, { "info": { "name": "Delete a feed. [Catalog Feed Delete](https://business-api.tiktok.com/portal/docs?id=1740665210863617)", "type": "http" }, "http": { "method": "POST", "url": "https://business-api.tiktok.com/open_api/v1.3/catalog/feed/delete/", "params": [ { "name": "Access-Token", "value": "", "type": "query", "description": "Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Delete a feed. [Catalog Feed Delete](https://business-api.tiktok.com/portal/docs?id=1740665210863617)" }, { "info": { "name": "Get all feeds or a particular feed. [Catalog Feed Get](https://business-api.tiktok.com/portal/docs?id=1740665183073281)", "type": "http" }, "http": { "method": "GET", "url": "https://business-api.tiktok.com/open_api/v1.3/catalog/feed/get/", "params": [ { "name": "bc_id", "value": "", "type": "query" }, { "name": "catalog_id", "value": "", "type": "query" }, { "name": "feed_id", "value": "", "type": "query" }, { "name": "Access-Token", "value": "", "type": "query", "description": "Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)." } ] }, "docs": "Get all feeds or a particular feed. [Catalog Feed Get](https://business-api.tiktok.com/portal/docs?id=1740665183073281)" }, { "info": { "name": "Get the last 10 operations of a feed. [Catalog Feed Log](https://business-api.tiktok.com/portal/docs?id=1740665225631810)", "type": "http" }, "http": { "method": "GET", "url": "https://business-api.tiktok.com/open_api/v1.3/catalog/feed/log/", "params": [ { "name": "bc_id", "value": "", "type": "query" }, { "name": "catalog_id", "value": "", "type": "query" }, { "name": "feed_id", "value": "", "type": "query" }, { "name": "context_info", "value": "", "type": "query" }, { "name": "Access-Token", "value": "", "type": "query", "description": "Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)." } ] }, "docs": "Get the last 10 operations of a feed. [Catalog Feed Log](https://business-api.tiktok.com/portal/docs?id=1740665225631810)" }, { "info": { "name": "Update a feed. [Catalog Feed Update](https://business-api.tiktok.com/portal/docs?id=1740665197662210)", "type": "http" }, "http": { "method": "POST", "url": "https://business-api.tiktok.com/open_api/v1.3/catalog/feed/update/", "params": [ { "name": "Access-Token", "value": "", "type": "query", "description": "Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a feed. [Catalog Feed Update](https://business-api.tiktok.com/portal/docs?id=1740665197662210)" }, { "info": { "name": "Get all catalogs or a particular catalog. [Catalog Get](https://business-api.tiktok.com/portal/docs?id=1740315452868610)", "type": "http" }, "http": { "method": "GET", "url": "https://business-api.tiktok.com/open_api/v1.3/catalog/get/", "params": [ { "name": "catalog_id", "value": "", "type": "query" }, { "name": "bc_id", "value": "", "type": "query" }, { "name": "page", "value": "", "type": "query" }, { "name": "page_size", "value": "", "type": "query" }, { "name": "Access-Token", "value": "", "type": "query", "description": "Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)." } ] }, "docs": "Get all catalogs or a particular catalog. [Catalog Get](https://business-api.tiktok.com/portal/docs?id=1740315452868610)" }, { "info": { "name": "Get the lexicon for your catalog for use in ad texts. [Catalog Lexicon Get](https://business-api.tiktok.com/portal/docs?id=1740488375815169)", "type": "http" }, "http": { "method": "GET", "url": "https://business-api.tiktok.com/open_api/v1.3/catalog/lexicon/get/", "params": [ { "name": "catalog_id", "value": "", "type": "query" }, { "name": "bc_id", "value": "", "type": "query" }, { "name": "Access-Token", "value": "", "type": "query", "description": "Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)." } ] }, "docs": "Get the lexicon for your catalog for use in ad texts. [Catalog Lexicon Get](https://business-api.tiktok.com/portal/docs?id=1740488375815169)" }, { "info": { "name": "Get supported locations and corresponding currencies for Catalog API. [Catalog Location Currency Get](https://business-api.tiktok.com/portal/docs?id=1740491571747841)", "type": "http" }, "http": { "method": "GET", "url": "https://business-api.tiktok.com/open_api/v1.3/catalog/location_currency/get/", "params": [ { "name": "Access-Token", "value": "", "type": "query", "description": "Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)." } ] }, "docs": "Get supported locations and corresponding currencies for Catalog API. [Catalog Location Currency Get](https://business-api.tiktok.com/portal/docs?id=1740491571747841)" }, { "info": { "name": "Get the number of products in different audit statuses in a catalog. [Catalog Overview](https://business-api.tiktok.com/portal/docs?id=1740492470201345)", "type": "http" }, "http": { "method": "GET", "url": "https://business-api.tiktok.com/open_api/v1.3/catalog/overview/", "params": [ { "name": "catalog_id", "value": "", "type": "query" }, { "name": "bc_id", "value": "", "type": "query" }, { "name": "Access-Token", "value": "", "type": "query", "description": "Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)." } ] }, "docs": "Get the number of products in different audit statuses in a catalog. [Catalog Overview](https://business-api.tiktok.com/portal/docs?id=1740492470201345)" }, { "info": { "name": "Delete products in bulk. [Catalog Product Delete](https://business-api.tiktok.com/portal/docs?id=1740562489236481)", "type": "http" }, "http": { "method": "POST", "url": "https://business-api.tiktok.com/open_api/v1.3/catalog/product/delete/", "params": [ { "name": "Access-Token", "value": "", "type": "query", "description": "Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Delete products in bulk. [Catalog Product Delete](https://business-api.tiktok.com/portal/docs?id=1740562489236481)" }, { "info": { "name": "Upload products via file URL. [Catalog Product File](https://business-api.tiktok.com/portal/docs?id=1740496787164161)", "type": "http" }, "http": { "method": "POST", "url": "https://business-api.tiktok.com/open_api/v1.3/catalog/product/file/", "params": [ { "name": "Access-Token", "value": "", "type": "query", "description": "Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Upload products via file URL. [Catalog Product File](https://business-api.tiktok.com/portal/docs?id=1740496787164161)" }, { "info": { "name": "Use this endpoint to find out if a product was uploaded or deleted successfully, and what to do if it failed. [Catalog Product Get](https://business-api.tiktok.com/portal/docs?id=1740570027173889)", "type": "http" }, "http": { "method": "GET", "url": "https://business-api.tiktok.com/open_api/v1.3/catalog/product/log/", "params": [ { "name": "bc_id", "value": "", "type": "query" }, { "name": "catalog_id", "value": "", "type": "query" }, { "name": "feed_log_id", "value": "", "type": "query" }, { "name": "advertiser_id", "value": "", "type": "query" }, { "name": "language", "value": "", "type": "query" }, { "name": "context_info", "value": "", "type": "query" }, { "name": "Access-Token", "value": "", "type": "query", "description": "Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)." } ] }, "docs": "Use this endpoint to find out if a product was uploaded or deleted successfully, and what to do if it failed. [Catalog Product Get](https://business-api.tiktok.com/portal/docs?id=1740570027173889)" }, { "info": { "name": "Delete product sets. [Catalog Set Delete](https://business-api.tiktok.com/portal/docs?id=1740573143966722)", "type": "http" }, "http": { "method": "POST", "url": "https://business-api.tiktok.com/open_api/v1.3/catalog/set/delete/", "params": [ { "name": "Access-Token", "value": "", "type": "query", "description": "Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Delete product sets. [Catalog Set Delete](https://business-api.tiktok.com/portal/docs?id=1740573143966722)" }, { "info": { "name": "Get product sets. [Catalog Set Get](https://business-api.tiktok.com/portal/docs?id=1740570556295169)", "type": "http" }, "http": { "method": "GET", "url": "https://business-api.tiktok.com/open_api/v1.3/catalog/set/get/", "params": [ { "name": "catalog_id", "value": "", "type": "query" }, { "name": "bc_id", "value": "", "type": "query" }, { "name": "product_set_id", "value": "", "type": "query" }, { "name": "return_product_count", "value": "", "type": "query" }, { "name": "Access-Token", "value": "", "type": "query", "description": "Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)." } ] }, "docs": "Get product sets. [Catalog Set Get](https://business-api.tiktok.com/portal/docs?id=1740570556295169)" }, { "info": { "name": "Use this endpoint to update the filter conditions or name of a product set. [Catalog Set Get](https://business-api.tiktok.com/portal/docs?id=1740572974725122)", "type": "http" }, "http": { "method": "POST", "url": "https://business-api.tiktok.com/open_api/v1.3/catalog/set/update/", "params": [ { "name": "Access-Token", "value": "", "type": "query", "description": "Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Use this endpoint to update the filter conditions or name of a product set. [Catalog Set Get](https://business-api.tiktok.com/portal/docs?id=1740572974725122)" }, { "info": { "name": "Use this endpoint to update the name of a catalog. The catalog must be under a Business Center. [Catalog Update](https://business-api.tiktok.com/portal/docs?id=1740306544966657)", "type": "http" }, "http": { "method": "POST", "url": "https://business-api.tiktok.com/open_api/v1.3/catalog/update/", "params": [ { "name": "Access-Token", "value": "", "type": "query", "description": "Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Use this endpoint to update the name of a catalog. The catalog must be under a Business Center. [Catalog Update](https://business-api.tiktok.com/portal/docs?id=1740306544966657)" }, { "info": { "name": "Delete uploaded catalog videos. [Catalog Video Delete](https://business-api.tiktok.com/portal/docs?id=1803655103069185)", "type": "http" }, "http": { "method": "POST", "url": "https://business-api.tiktok.com/open_api/v1.3/catalog/video/delete/", "params": [ { "name": "Access-Token", "value": "", "type": "query", "description": "Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Delete uploaded catalog videos. [Catalog Video Delete](https://business-api.tiktok.com/portal/docs?id=1803655103069185)" }, { "info": { "name": "Catalog Video File", "type": "http" }, "http": { "method": "POST", "url": "https://business-api.tiktok.com/open_api/v1.3/catalog/video/file/", "params": [ { "name": "Access-Token", "value": "", "type": "query", "description": "Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)." } ], "body": { "type": "json", "data": "{}" } } }, { "info": { "name": "Catalog Video Get", "type": "http" }, "http": { "method": "GET", "url": "https://business-api.tiktok.com/open_api/v1.3/catalog/video/get/", "params": [ { "name": "bc_id", "value": "", "type": "query" }, { "name": "catalog_id", "value": "", "type": "query" }, { "name": "catalog_video_ids", "value": "", "type": "query" }, { "name": "page", "value": "", "type": "query" }, { "name": "page_size", "value": "", "type": "query" }, { "name": "Access-Token", "value": "", "type": "query", "description": "Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)." } ] } } ] }, { "info": { "name": "catalog", "type": "folder" }, "items": [ { "info": { "name": "Get products in a product set. [Catalog Set Product Get](https://business-api.tiktok.com/portal/docs?id=1740571478441986)", "type": "http" }, "http": { "method": "GET", "url": "https://business-api.tiktok.com/open_api/v1.3/catalog/set/product/get/", "params": [ { "name": "bc_id", "value": "", "type": "query" }, { "name": "catalog_id", "value": "", "type": "query" }, { "name": "product_set_id", "value": "", "type": "query" }, { "name": "page", "value": "", "type": "query" }, { "name": "page_size", "value": "", "type": "query" }, { "name": "Access-Token", "value": "", "type": "query", "description": "Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)." } ] }, "docs": "Get products in a product set. [Catalog Set Product Get](https://business-api.tiktok.com/portal/docs?id=1740571478441986)" } ] }, { "info": { "name": "Creative Management", "type": "folder" }, "items": [ { "info": { "name": "Delete creative assets. [Asset Delete](https://business-api.tiktok.com/portal/docs?id=1797202997456897)", "type": "http" }, "http": { "method": "POST", "url": "https://business-api.tiktok.com/open_api/v1.3/creative/asset/delete/", "params": [ { "name": "Access-Token", "value": "", "type": "query", "description": "Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Delete creative assets. [Asset Delete](https://business-api.tiktok.com/portal/docs?id=1797202997456897)" }, { "info": { "name": "SShare creative assets with other advertiser accounts. [Asset Share](https://business-api.tiktok.com/portal/docs?id=1773192725768193)", "type": "http" }, "http": { "method": "POST", "url": "https://business-api.tiktok.com/open_api/v1.3/creative/asset/share/", "params": [ { "name": "Access-Token", "value": "", "type": "query", "description": "Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "SShare creative assets with other advertiser accounts. [Asset Share](https://business-api.tiktok.com/portal/docs?id=1773192725768193)" }, { "info": { "name": "Edit an image according to the size you want as well as apply creative trimmings. [Image Edit](https://business-api.tiktok.com/portal/docs?id=1739067107903489)", "type": "http" }, "http": { "method": "POST", "url": "https://business-api.tiktok.com/open_api/v1.3/creative/image/edit/", "params": [ { "name": "Access-Token", "value": "", "type": "query", "description": "Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Edit an image according to the size you want as well as apply creative trimmings. [Image Edit](https://business-api.tiktok.com/portal/docs?id=1739067107903489)" }, { "info": { "name": "Create a portfolio. [Creative Portfolie Create](https://business-api.tiktok.com/portal/docs?id=1739091950439426)", "type": "http" }, "http": { "method": "POST", "url": "https://business-api.tiktok.com/open_api/v1.3/creative/portfolio/create/", "params": [ { "name": "Access-Token", "value": "", "type": "query", "description": "Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a portfolio. [Creative Portfolie Create](https://business-api.tiktok.com/portal/docs?id=1739091950439426)" }, { "info": { "name": "Get a portfolio by ID. [Portfolio Get](https://business-api.tiktok.com/portal/docs?id=1739092113671170)", "type": "http" }, "http": { "method": "GET", "url": "https://business-api.tiktok.com/open_api/v1.3/creative/portfolio/get/", "params": [ { "name": "advertiser_id", "value": "", "type": "query" }, { "name": "creative_portfolio_id", "value": "", "type": "query" }, { "name": "Access-Token", "value": "", "type": "query", "description": "Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)." } ] }, "docs": "Get a portfolio by ID. [Portfolio Get](https://business-api.tiktok.com/portal/docs?id=1739092113671170)" }, { "info": { "name": "Get portfolios within an ad account. [Portfolio List](https://business-api.tiktok.com/portal/docs?id=1766324010279938)", "type": "http" }, "http": { "method": "GET", "url": "https://business-api.tiktok.com/open_api/v1.3/creative/portfolio/list/", "params": [ { "name": "advertiser_id", "value": "", "type": "query" }, { "name": "filtering", "value": "", "type": "query" }, { "name": "page", "value": "", "type": "query" }, { "name": "page_size", "value": "", "type": "query" }, { "name": "Access-Token", "value": "", "type": "query", "description": "Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)." } ] }, "docs": "Get portfolios within an ad account. [Portfolio List](https://business-api.tiktok.com/portal/docs?id=1766324010279938)" }, { "info": { "name": "Creative Shareable_link Create", "type": "http" }, "http": { "method": "POST", "url": "https://business-api.tiktok.com/open_api/v1.3/creative/shareable_link/create/", "params": [ { "name": "Access-Token", "value": "", "type": "query", "description": "Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)." } ], "body": { "type": "json", "data": "{}" } } }, { "info": { "name": "Use smart text. [Smart Text Generate](https://business-api.tiktok.com/portal/docs?id=1739084248002626)", "type": "http" }, "http": { "method": "POST", "url": "https://business-api.tiktok.com/open_api/v1.3/creative/smart_text/generate/", "params": [ { "name": "Access-Token", "value": "", "type": "query", "description": "Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Use smart text. [Smart Text Generate](https://business-api.tiktok.com/portal/docs?id=1739084248002626)" }, { "info": { "name": "Get details of a popular hashtag. [Discovery Detail](https://business-api.tiktok.com/portal/docs?id=1825119047070721)", "type": "http" }, "http": { "method": "GET", "url": "https://business-api.tiktok.com/open_api/v1.3/discovery/detail/", "params": [ { "name": "hashtag_id", "value": "", "type": "query" }, { "name": "discovery_type", "value": "", "type": "query" }, { "name": "country_code", "value": "", "type": "query" }, { "name": "date_range", "value": "", "type": "query" }, { "name": "advertiser_id", "value": "", "type": "query" }, { "name": "Access-Token", "value": "", "type": "query", "description": "Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)." } ] }, "docs": "Get details of a popular hashtag. [Discovery Detail](https://business-api.tiktok.com/portal/docs?id=1825119047070721)" }, { "info": { "name": "Get popular hashtags. [Trending List](https://business-api.tiktok.com/portal/docs?id=1825119032526849)", "type": "http" }, "http": { "method": "GET", "url": "https://business-api.tiktok.com/open_api/v1.3/discovery/trending_list/", "params": [ { "name": "discovery_type", "value": "", "type": "query" }, { "name": "country_code", "value": "", "type": "query" }, { "name": "category_name", "value": "", "type": "query" }, { "name": "date_range", "value": "", "type": "query" }, { "name": "advertiser_id", "value": "", "type": "query" }, { "name": "Access-Token", "value": "", "type": "query", "description": "Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)." } ] }, "docs": "Get popular hashtags. [Trending List](https://business-api.tiktok.com/portal/docs?id=1825119032526849)" }, { "info": { "name": "Delete a playable ad. [Playable Delete](https://business-api.tiktok.com/portal/docs?id=1737733368940546)", "type": "http" }, "http": { "method": "POST", "url": "https://business-api.tiktok.com/open_api/v1.3/playable/delete/", "params": [ { "name": "Access-Token", "value": "", "type": "query", "description": "Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Delete a playable ad. [Playable Delete](https://business-api.tiktok.com/portal/docs?id=1737733368940546)" }, { "info": { "name": "Use this endpoint to get a list of playables. [Playable Get](https://business-api.tiktok.com/portal/docs?id=1737732758495234)", "type": "http" }, "http": { "method": "GET", "url": "https://business-api.tiktok.com/open_api/v1.3/playable/get/", "params": [ { "name": "advertiser_id", "value": "", "type": "query" }, { "name": "playable_id", "value": "", "type": "query" }, { "name": "playable_url", "value": "", "type": "query" }, { "name": "playable_name", "value": "", "type": "query" }, { "name": "status", "value": "", "type": "query" }, { "name": "operation_status", "value": "", "type": "query" }, { "name": "page", "value": "", "type": "query" }, { "name": "page_size", "value": "", "type": "query" }, { "name": "Access-Token", "value": "", "type": "query", "description": "Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)." } ] }, "docs": "Use this endpoint to get a list of playables. [Playable Get](https://business-api.tiktok.com/portal/docs?id=1737732758495234)" }, { "info": { "name": "Use this endpoint to save a playable. [Playable Save](https://business-api.tiktok.com/portal/docs?id=1737732203851777)", "type": "http" }, "http": { "method": "POST", "url": "https://business-api.tiktok.com/open_api/v1.3/playable/save/", "params": [ { "name": "Access-Token", "value": "", "type": "query", "description": "Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Use this endpoint to save a playable. [Playable Save](https://business-api.tiktok.com/portal/docs?id=1737732203851777)" }, { "info": { "name": "You can use this endpoint to upload Playable Ad contents. [Playable Upload](https://business-api.tiktok.com/portal/docs?id=1737730926765057)", "type": "http" }, "http": { "method": "POST", "url": "https://business-api.tiktok.com/open_api/v1.3/playable/upload/", "params": [ { "name": "Access-Token", "value": "", "type": "query", "description": "Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)." } ], "body": { "type": "multipart-form", "data": [ { "name": "advertiser_id", "type": "text", "value": "" }, { "name": "file_id", "type": "text", "value": "" }, { "name": "playable_package", "type": "text", "value": "" }, { "name": "upload_type", "type": "text", "value": "" } ] } }, "docs": "You can use this endpoint to upload Playable Ad contents. [Playable Upload](https://business-api.tiktok.com/portal/docs?id=1737730926765057)" }, { "info": { "name": "Check the status of the playable. [Playable Validate](https://business-api.tiktok.com/portal/docs?id=1737732054892545)", "type": "http" }, "http": { "method": "GET", "url": "https://business-api.tiktok.com/open_api/v1.3/playable/validate/", "params": [ { "name": "advertiser_id", "value": "", "type": "query" }, { "name": "playable_id", "value": "", "type": "query" }, { "name": "Access-Token", "value": "", "type": "query", "description": "Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)." } ] }, "docs": "Check the status of the playable. [Playable Validate](https://business-api.tiktok.com/portal/docs?id=1737732054892545)" } ] }, { "info": { "name": "Store", "type": "folder" }, "items": [ { "info": { "name": "Create GMV Max exclusive authorization [Smart Plus GMV Max Exclusive Authorization Create](https://business-api.tiktok.com/portal/docs?id=1822001200356354)", "type": "http" }, "http": { "method": "POST", "url": "https://business-api.tiktok.com/open_api/v1.3/gmv_max/exclusive_authorization/create/", "params": [ { "name": "Access-Token", "value": "", "type": "query", "description": "Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create GMV Max exclusive authorization [Smart Plus GMV Max Exclusive Authorization Create](https://business-api.tiktok.com/portal/docs?id=1822001200356354)" }, { "info": { "name": "Get GMV Max exclusive authorization [Smart Plus GMV Max Exclusive Authorization Get](https://business-api.tiktok.com/portal/docs?id=1822001184635905)", "type": "http" }, "http": { "method": "GET", "url": "https://business-api.tiktok.com/open_api/v1.3/gmv_max/exclusive_authorization/get/", "params": [ { "name": "advertiser_id", "value": "", "type": "query" }, { "name": "store_id", "value": "", "type": "query" }, { "name": "store_authorized_bc_id", "value": "", "type": "query" }, { "name": "Access-Token", "value": "", "type": "query", "description": "Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)." } ] }, "docs": "Get GMV Max exclusive authorization [Smart Plus GMV Max Exclusive Authorization Get](https://business-api.tiktok.com/portal/docs?id=1822001184635905)" }, { "info": { "name": "Get GMV Max store list [Smart Plus GMV Max Store List](https://business-api.tiktok.com/portal/docs?id=1822001044479041)", "type": "http" }, "http": { "method": "GET", "url": "https://business-api.tiktok.com/open_api/v1.3/gmv_max/store/list/", "params": [ { "name": "advertiser_id", "value": "", "type": "query" }, { "name": "Access-Token", "value": "", "type": "query", "description": "Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)." } ] }, "docs": "Get GMV Max store list [Smart Plus GMV Max Store List](https://business-api.tiktok.com/portal/docs?id=1822001044479041)" }, { "info": { "name": "Check GMV Max shop ad usage [Smart Plus GMV Max Shop Ad Usage Check](https://business-api.tiktok.com/portal/docs?id=1822001084174338)", "type": "http" }, "http": { "method": "GET", "url": "https://business-api.tiktok.com/open_api/v1.3/gmv_max/store/shop_ad_usage_check/", "params": [ { "name": "advertiser_id", "value": "", "type": "query" }, { "name": "store_id", "value": "", "type": "query" }, { "name": "Access-Token", "value": "", "type": "query", "description": "Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)." } ] }, "docs": "Check GMV Max shop ad usage [Smart Plus GMV Max Shop Ad Usage Check](https://business-api.tiktok.com/portal/docs?id=1822001084174338)" } ] }, { "info": { "name": "Identity", "type": "folder" }, "items": [ { "info": { "name": "Get GMV Max identity info [Smart Plus GMV Max Identity Get](https://business-api.tiktok.com/portal/docs?id=1822001101474882)", "type": "http" }, "http": { "method": "GET", "url": "https://business-api.tiktok.com/open_api/v1.3/gmv_max/identity/get/", "params": [ { "name": "advertiser_id", "value": "", "type": "query" }, { "name": "store_id", "value": "", "type": "query" }, { "name": "store_authorized_bc_id", "value": "", "type": "query" }, { "name": "Access-Token", "value": "", "type": "query", "description": "Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)." } ] }, "docs": "Get GMV Max identity info [Smart Plus GMV Max Identity Get](https://business-api.tiktok.com/portal/docs?id=1822001101474882)" } ] }, { "info": { "name": "Reporting", "type": "folder" }, "items": [ { "info": { "name": "Get GMV Max report [Smart Plus GMV Max Report Get](https://business-api.tiktok.com/portal/docs?id=1824721673497601)", "type": "http" }, "http": { "method": "GET", "url": "https://business-api.tiktok.com/open_api/v1.3/gmv_max/report/get/", "params": [ { "name": "advertiser_id", "value": "", "type": "query" }, { "name": "store_ids", "value": "", "type": "query" }, { "name": "dimensions", "value": "", "type": "query" }, { "name": "metrics", "value": "", "type": "query" }, { "name": "enable_total_metrics", "value": "", "type": "query" }, { "name": "start_date", "value": "", "type": "query" }, { "name": "end_date", "value": "", "type": "query" }, { "name": "filtering", "value": "", "type": "query" }, { "name": "sort_field", "value": "", "type": "query" }, { "name": "sort_type", "value": "", "type": "query" }, { "name": "page", "value": "", "type": "query" }, { "name": "page_size", "value": "", "type": "query" }, { "name": "context_info", "value": "", "type": "query" }, { "name": "Access-Token", "value": "", "type": "query", "description": "Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)." } ] }, "docs": "Get GMV Max report [Smart Plus GMV Max Report Get](https://business-api.tiktok.com/portal/docs?id=1824721673497601)" }, { "info": { "name": "Run a synchronous report. [Report Integrated Get](https://business-api.tiktok.com/portal/docs?id=1740302848100353)", "type": "http" }, "http": { "method": "GET", "url": "https://business-api.tiktok.com/open_api/v1.3/report/integrated/get/", "params": [ { "name": "page", "value": "", "type": "query" }, { "name": "page_size", "value": "", "type": "query" }, { "name": "enable_total_metrics", "value": "", "type": "query" }, { "name": "multi_adv_report_in_utc_time", "value": "", "type": "query" }, { "name": "query_mode", "value": "", "type": "query" }, { "name": "advertiser_id", "value": "", "type": "query" }, { "name": "advertiser_ids", "value": "", "type": "query" }, { "name": "bc_id", "value": "", "type": "query" }, { "name": "service_type", "value": "", "type": "query" }, { "name": "report_type", "value": "", "type": "query" }, { "name": "data_level", "value": "", "type": "query" }, { "name": "dimensions", "value": "", "type": "query" }, { "name": "metrics", "value": "", "type": "query" }, { "name": "start_date", "value": "", "type": "query" }, { "name": "end_date", "value": "", "type": "query" }, { "name": "query_lifetime", "value": "", "type": "query" }, { "name": "order_field", "value": "", "type": "query" }, { "name": "order_type", "value": "", "type": "query" }, { "name": "filtering", "value": "", "type": "query" }, { "name": "Access-Token", "value": "", "type": "query", "description": "Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)." } ] }, "docs": "Run a synchronous report. [Report Integrated Get](https://business-api.tiktok.com/portal/docs?id=1740302848100353)" }, { "info": { "name": "Cancel an asynchronous report task. [Report Task Cancel](https://business-api.tiktok.com/portal/docs?id=1803615367145537)", "type": "http" }, "http": { "method": "POST", "url": "https://business-api.tiktok.com/open_api/v1.3/report/task/cancel/", "params": [ { "name": "Access-Token", "value": "", "type": "query", "description": "Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Cancel an asynchronous report task. [Report Task Cancel](https://business-api.tiktok.com/portal/docs?id=1803615367145537)" }, { "info": { "name": "Get the status of an async report task. [Report Task Check](https://business-api.tiktok.com/portal/docs?id=1740302781443073)", "type": "http" }, "http": { "method": "GET", "url": "https://business-api.tiktok.com/open_api/v1.3/report/task/check/", "params": [ { "name": "task_id", "value": "", "type": "query" }, { "name": "advertiser_id", "value": "", "type": "query" }, { "name": "Access-Token", "value": "", "type": "query", "description": "Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)." } ] }, "docs": "Get the status of an async report task. [Report Task Check](https://business-api.tiktok.com/portal/docs?id=1740302781443073)" }, { "info": { "name": "Report Task Create", "type": "http" }, "http": { "method": "POST", "url": "https://business-api.tiktok.com/open_api/v1.3/report/task/create/", "params": [ { "name": "Access-Token", "value": "", "type": "query", "description": "Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)." } ], "body": { "type": "json", "data": "{}" } } }, { "info": { "name": "Get breakdown of material reports [Smart Plus Material Report Breakdown]", "type": "http" }, "http": { "method": "GET", "url": "https://business-api.tiktok.com/open_api/v1.3/smart_plus/material_report/breakdown/", "params": [ { "name": "advertiser_id", "value": "", "type": "query" }, { "name": "dimensions", "value": "", "type": "query" }, { "name": "metrics", "value": "", "type": "query" }, { "name": "start_date", "value": "", "type": "query" }, { "name": "end_date", "value": "", "type": "query" }, { "name": "filtering", "value": "", "type": "query" }, { "name": "sort_field", "value": "", "type": "query" }, { "name": "sort_type", "value": "", "type": "query" }, { "name": "page", "value": "", "type": "query" }, { "name": "page_size", "value": "", "type": "query" }, { "name": "Access-Token", "value": "", "type": "query", "description": "Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)." } ] }, "docs": "Get breakdown of material reports [Smart Plus Material Report Breakdown]" }, { "info": { "name": "Get overview of material reports [Smart Plus Material Report Overview]", "type": "http" }, "http": { "method": "GET", "url": "https://business-api.tiktok.com/open_api/v1.3/smart_plus/material_report/overview/", "params": [ { "name": "advertiser_id", "value": "", "type": "query" }, { "name": "dimensions", "value": "", "type": "query" }, { "name": "metrics", "value": "", "type": "query" }, { "name": "start_date", "value": "", "type": "query" }, { "name": "end_date", "value": "", "type": "query" }, { "name": "query_lifetime", "value": "", "type": "query" }, { "name": "filtering", "value": "", "type": "query" }, { "name": "sort_field", "value": "", "type": "query" }, { "name": "sort_type", "value": "", "type": "query" }, { "name": "page", "value": "", "type": "query" }, { "name": "page_size", "value": "", "type": "query" }, { "name": "Access-Token", "value": "", "type": "query", "description": "Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)." } ] }, "docs": "Get overview of material reports [Smart Plus Material Report Overview]" } ] }, { "info": { "name": "Video", "type": "folder" }, "items": [ { "info": { "name": "Get GMV Max video info [Smart Plus GMV Max Video Get](https://business-api.tiktok.com/portal/docs?id=1822001168512129)", "type": "http" }, "http": { "method": "GET", "url": "https://business-api.tiktok.com/open_api/v1.3/gmv_max/video/get/", "params": [ { "name": "advertiser_id", "value": "", "type": "query" }, { "name": "store_id", "value": "", "type": "query" }, { "name": "store_authorized_bc_id", "value": "", "type": "query" }, { "name": "spu_id_list", "value": "", "type": "query" }, { "name": "identity_list", "value": "", "type": "query" }, { "name": "need_auth_code_video", "value": "", "type": "query" }, { "name": "page", "value": "", "type": "query" }, { "name": "page_size", "value": "", "type": "query" }, { "name": "custom_posts_eligible", "value": "", "type": "query" }, { "name": "sort_field", "value": "", "type": "query" }, { "name": "sort_type", "value": "", "type": "query" }, { "name": "keyword", "value": "", "type": "query" }, { "name": "Access-Token", "value": "", "type": "query", "description": "Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)." } ] }, "docs": "Get GMV Max video info [Smart Plus GMV Max Video Get](https://business-api.tiktok.com/portal/docs?id=1822001168512129)" } ] }, { "info": { "name": "Measurement", "type": "folder" }, "items": [ { "info": { "name": "Create a new Offline Event set. [Offline Create](https://business-api.tiktok.com/portal/docs?id=1758427576470529)", "type": "http" }, "http": { "method": "POST", "url": "https://business-api.tiktok.com/open_api/v1.3/offline/create/", "params": [ { "name": "Access-Token", "value": "", "type": "query", "description": "Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a new Offline Event set. [Offline Create](https://business-api.tiktok.com/portal/docs?id=1758427576470529)" }, { "info": { "name": "Delete an Offline Event set. [Offline Delete](https://business-api.tiktok.com/portal/docs?id=1765596790860802)", "type": "http" }, "http": { "method": "POST", "url": "https://business-api.tiktok.com/open_api/v1.3/offline/delete/", "params": [ { "name": "Access-Token", "value": "", "type": "query", "description": "Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Delete an Offline Event set. [Offline Delete](https://business-api.tiktok.com/portal/docs?id=1765596790860802)" }, { "info": { "name": "Get Offline Event sets. [Offline Get](https://business-api.tiktok.com/portal/docs?id=1765596808589313)", "type": "http" }, "http": { "method": "GET", "url": "https://business-api.tiktok.com/open_api/v1.3/offline/get/", "params": [ { "name": "advertiser_id", "value": "", "type": "query" }, { "name": "event_set_ids", "value": "", "type": "query" }, { "name": "name", "value": "", "type": "query" }, { "name": "Access-Token", "value": "", "type": "query", "description": "Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)." } ] }, "docs": "Get Offline Event sets. [Offline Get](https://business-api.tiktok.com/portal/docs?id=1765596808589313)" }, { "info": { "name": "Update an Offline Event set. [Offline Update](https://business-api.tiktok.com/portal/docs?id=1765596741157889)", "type": "http" }, "http": { "method": "POST", "url": "https://business-api.tiktok.com/open_api/v1.3/offline/update/", "params": [ { "name": "Access-Token", "value": "", "type": "query", "description": "Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update an Offline Event set. [Offline Update](https://business-api.tiktok.com/portal/docs?id=1765596741157889)" }, { "info": { "name": "Create a Pixel. [Pixel Create](https://business-api.tiktok.com/portal/docs?id=1740858779758593)", "type": "http" }, "http": { "method": "POST", "url": "https://business-api.tiktok.com/open_api/v1.3/pixel/create/", "params": [ { "name": "Access-Token", "value": "", "type": "query", "description": "Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a Pixel. [Pixel Create](https://business-api.tiktok.com/portal/docs?id=1740858779758593)" }, { "info": { "name": "Choose either an industry or custom template to define your events. [Pixel Event Create](https://business-api.tiktok.com/portal/docs?id=1740858807646209)", "type": "http" }, "http": { "method": "POST", "url": "https://business-api.tiktok.com/open_api/v1.3/pixel/event/create/", "params": [ { "name": "Access-Token", "value": "", "type": "query", "description": "Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Choose either an industry or custom template to define your events. [Pixel Event Create](https://business-api.tiktok.com/portal/docs?id=1740858807646209)" }, { "info": { "name": "Delete Pixel events. [Pixel Event Delete](https://business-api.tiktok.com/portal/docs?id=1740858862104578)", "type": "http" }, "http": { "method": "POST", "url": "https://business-api.tiktok.com/open_api/v1.3/pixel/event/delete/", "params": [ { "name": "Access-Token", "value": "", "type": "query", "description": "Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Delete Pixel events. [Pixel Event Delete](https://business-api.tiktok.com/portal/docs?id=1740858862104578)" }, { "info": { "name": "View statistics of an event data over a period of time. [Pixel Event Stats](https://business-api.tiktok.com/portal/docs?id=1740858904557570)", "type": "http" }, "http": { "method": "GET", "url": "https://business-api.tiktok.com/open_api/v1.3/pixel/event/stats/", "params": [ { "name": "advertiser_id", "value": "", "type": "query" }, { "name": "pixel_ids", "value": "", "type": "query" }, { "name": "date_range", "value": "", "type": "query" }, { "name": "Access-Token", "value": "", "type": "query", "description": "Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)." } ] }, "docs": "View statistics of an event data over a period of time. [Pixel Event Stats](https://business-api.tiktok.com/portal/docs?id=1740858904557570)" }, { "info": { "name": "Update the name of a Pixel event and the conversion value. [Pixel Event Update](https://business-api.tiktok.com/portal/docs?id=1740858823774210)", "type": "http" }, "http": { "method": "POST", "url": "https://business-api.tiktok.com/open_api/v1.3/pixel/event/update/", "params": [ { "name": "Access-Token", "value": "", "type": "query", "description": "Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update the name of a Pixel event and the conversion value. [Pixel Event Update](https://business-api.tiktok.com/portal/docs?id=1740858823774210)" }, { "info": { "name": "Obtain a list of Pixel information. [Pixel List](https://business-api.tiktok.com/portal/docs?id=1740858697598978)", "type": "http" }, "http": { "method": "GET", "url": "https://business-api.tiktok.com/open_api/v1.3/pixel/list/", "params": [ { "name": "advertiser_id", "value": "", "type": "query" }, { "name": "pixel_id", "value": "", "type": "query" }, { "name": "code", "value": "", "type": "query" }, { "name": "name", "value": "", "type": "query" }, { "name": "order_by", "value": "", "type": "query" }, { "name": "filtering", "value": "", "type": "query" }, { "name": "page", "value": "", "type": "query" }, { "name": "page_size", "value": "", "type": "query" }, { "name": "Access-Token", "value": "", "type": "query", "description": "Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)." } ] }, "docs": "Obtain a list of Pixel information. [Pixel List](https://business-api.tiktok.com/portal/docs?id=1740858697598978)" }, { "info": { "name": "Update a Pixel. [Pixel Update](https://business-api.tiktok.com/portal/docs?id=1740858799524865)", "type": "http" }, "http": { "method": "POST", "url": "https://business-api.tiktok.com/open_api/v1.3/pixel/update/", "params": [ { "name": "Access-Token", "value": "", "type": "query", "description": "Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a Pixel. [Pixel Update](https://business-api.tiktok.com/portal/docs?id=1740858799524865)" } ] }, { "info": { "name": "Automated_Rules", "type": "folder" }, "items": [ { "info": { "name": "Bind objects to rules. [Optimizer Rule Batch Bind](https://business-api.tiktok.com/portal/docs?id=1738769164954626)", "type": "http" }, "http": { "method": "POST", "url": "https://business-api.tiktok.com/open_api/v1.3/optimizer/rule/batch_bind/", "params": [ { "name": "Access-Token", "value": "", "type": "query", "description": "Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Bind objects to rules. [Optimizer Rule Batch Bind](https://business-api.tiktok.com/portal/docs?id=1738769164954626)" }, { "info": { "name": "Create an automated rule. [Optimizer Rule Create](https://business-api.tiktok.com/portal/docs?id=1738767670852610)", "type": "http" }, "http": { "method": "POST", "url": "https://business-api.tiktok.com/open_api/v1.3/optimizer/rule/create/", "params": [ { "name": "Access-Token", "value": "", "type": "query", "description": "Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create an automated rule. [Optimizer Rule Create](https://business-api.tiktok.com/portal/docs?id=1738767670852610)" }, { "info": { "name": "Get rules by rule IDs. [Optimizer Rule Get](https://business-api.tiktok.com/portal/docs?id=1738768750822466)", "type": "http" }, "http": { "method": "GET", "url": "https://business-api.tiktok.com/open_api/v1.3/optimizer/rule/get/", "params": [ { "name": "advertiser_id", "value": "", "type": "query" }, { "name": "rule_ids", "value": "", "type": "query" }, { "name": "Access-Token", "value": "", "type": "query", "description": "Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)." } ] }, "docs": "Get rules by rule IDs. [Optimizer Rule Get](https://business-api.tiktok.com/portal/docs?id=1738768750822466)" }, { "info": { "name": "Get rules based on the values of certain filters. [Optimizer Rule List](https://business-api.tiktok.com/portal/docs?id=1738768861976578)", "type": "http" }, "http": { "method": "GET", "url": "https://business-api.tiktok.com/open_api/v1.3/optimizer/rule/list/", "params": [ { "name": "advertiser_id", "value": "", "type": "query" }, { "name": "filtering", "value": "", "type": "query" }, { "name": "tzone", "value": "", "type": "query" }, { "name": "page", "value": "", "type": "query" }, { "name": "page_size", "value": "", "type": "query" }, { "name": "Access-Token", "value": "", "type": "query", "description": "Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)." } ] }, "docs": "Get rules based on the values of certain filters. [Optimizer Rule List](https://business-api.tiktok.com/portal/docs?id=1738768861976578)" }, { "info": { "name": "Get result details. [Optimizer Rule Result Get](https://business-api.tiktok.com/portal/docs?id=1738769098314754)", "type": "http" }, "http": { "method": "GET", "url": "https://business-api.tiktok.com/open_api/v1.3/optimizer/rule/result/get/", "params": [ { "name": "advertiser_id", "value": "", "type": "query" }, { "name": "result_detail", "value": "", "type": "query" }, { "name": "lang", "value": "", "type": "query" }, { "name": "Access-Token", "value": "", "type": "query", "description": "Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)." } ] }, "docs": "Get result details. [Optimizer Rule Result Get](https://business-api.tiktok.com/portal/docs?id=1738769098314754)" }, { "info": { "name": "Get rule results. [Optimizer Rule Result List](https://business-api.tiktok.com/portal/docs?id=1738769076676609)", "type": "http" }, "http": { "method": "GET", "url": "https://business-api.tiktok.com/open_api/v1.3/optimizer/rule/result/list/", "params": [ { "name": "advertiser_id", "value": "", "type": "query" }, { "name": "filtering", "value": "", "type": "query" }, { "name": "lang", "value": "", "type": "query" }, { "name": "page", "value": "", "type": "query" }, { "name": "page_size", "value": "", "type": "query" }, { "name": "Access-Token", "value": "", "type": "query", "description": "Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)." } ] }, "docs": "Get rule results. [Optimizer Rule Result List](https://business-api.tiktok.com/portal/docs?id=1738769076676609)" }, { "info": { "name": "Update an automated rule. [Optimizer Rule Update](https://business-api.tiktok.com/portal/docs?id=1738769123170306)", "type": "http" }, "http": { "method": "POST", "url": "https://business-api.tiktok.com/open_api/v1.3/optimizer/rule/update/", "params": [ { "name": "Access-Token", "value": "", "type": "query", "description": "Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update an automated rule. [Optimizer Rule Update](https://business-api.tiktok.com/portal/docs?id=1738769123170306)" } ] }, { "info": { "name": "Tool", "type": "folder" }, "items": [ { "info": { "name": "Get available locations by advertiser ID [Search Region](https://ads.tiktok.com/marketing_api/docs?id=1773644763581441)", "type": "http" }, "http": { "method": "GET", "url": "https://business-api.tiktok.com/open_api/v1.3/search/region/", "params": [ { "name": "advertiser_id", "value": "", "type": "query", "description": "Advertiser ID." }, { "name": "language", "value": "", "type": "query", "description": "The language you want the returned region name to be translated into. Default value: en Currently, we only support zh, fr, es, ko, vi, en, hi, it, tr, ru, ja, id, de, ms, ar, and th Note: If you do not pass in one of the supported values above, it will return as the default en." }, { "name": "Access-Token", "value": "", "type": "query", "description": "Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)." } ] }, "docs": "Get available locations by advertiser ID [Search Region](https://ads.tiktok.com/marketing_api/docs?id=1773644763581441)" }, { "info": { "name": "Get action categories. [Tool Action Category](https://business-api.tiktok.com/portal/docs?id=1737166752522241)", "type": "http" }, "http": { "method": "GET", "url": "https://business-api.tiktok.com/open_api/v1.3/tool/action_category/", "params": [ { "name": "advertiser_id", "value": "", "type": "query", "description": "Advertiser ID." }, { "name": "special_industries", "value": "", "type": "query", "description": "Special ad categories. Enum values: HOUSING: Ads for real estate listings, homeowners insurance, mortgage loans or other related opportunities. EMPLOYMENT: Ads for job offers, internship, professional certification programs or other related opportunities. CREDIT: Ads for credit card offers, auto loans, long-term financing or other related opportunities. Note: This field is generally available to advertisers registered in America or Canada. Advertisers who are not registered in America or Canada but want to target these countries with special ad categories need to apply for an additional allowlist." }, { "name": "language", "value": "", "type": "query", "description": "Category name language in repsonse. Default value: en. Supported languages: en, zh, ja, de, es, fr, id, it, ko, ru, th, tr, vi, ar, pt, ms. For details, see Enumeration - Language Code." }, { "name": "Access-Token", "value": "", "type": "query", "description": "Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)." } ] }, "docs": "Get action categories. [Tool Action Category](https://business-api.tiktok.com/portal/docs?id=1737166752522241)" }, { "info": { "name": "Get a suggested bid [Tool Bid Recommend](https://ads.tiktok.com/marketing_api/docs?id=1737107845597186)", "type": "http" }, "http": { "method": "POST", "url": "https://business-api.tiktok.com/open_api/v1.3/tool/bid/recommend/", "params": [ { "name": "Access-Token", "value": "", "type": "query", "description": "Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Get a suggested bid [Tool Bid Recommend](https://ads.tiktok.com/marketing_api/docs?id=1737107845597186)" }, { "info": { "name": "Get the authorization status of a Brand Safety partner [Tool Brand_safety Partner Authorize Status](https://ads.tiktok.com/marketing_api/docs?id=1738456743621634)", "type": "http" }, "http": { "method": "GET", "url": "https://business-api.tiktok.com/open_api/v1.3/tool/brand_safety/partner/authorize/status/", "params": [ { "name": "partner", "value": "", "type": "query", "description": "Brand Safety post bid measurement partner. Enum values: Zefr." }, { "name": "advertiser_id", "value": "", "type": "query", "description": "Advertiser ID" }, { "name": "Access-Token", "value": "", "type": "query", "description": "Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)." } ] }, "docs": "Get the authorization status of a Brand Safety partner [Tool Brand_safety Partner Authorize Status](https://ads.tiktok.com/marketing_api/docs?id=1738456743621634)" }, { "info": { "name": "Get carriers. [Tool Carrier](https://business-api.tiktok.com/portal/docs?id=1737168013095938)", "type": "http" }, "http": { "method": "GET", "url": "https://business-api.tiktok.com/open_api/v1.3/tool/carrier/", "params": [ { "name": "advertiser_id", "value": "", "type": "query", "description": "Advertiser ID" }, { "name": "Access-Token", "value": "", "type": "query", "description": "Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)." } ] }, "docs": "Get carriers. [Tool Carrier](https://business-api.tiktok.com/portal/docs?id=1737168013095938)" }, { "info": { "name": "Get available contextual tags [Tool Contextual_tag Get](https://ads.tiktok.com/marketing_api/docs?id=1747747118654465)", "type": "http" }, "http": { "method": "GET", "url": "https://business-api.tiktok.com/open_api/v1.3/tool/contextual_tag/get/", "params": [ { "name": "advertiser_id", "value": "", "type": "query", "description": "Advertiser ID." }, { "name": "objective_type", "value": "", "type": "query", "description": "Advertising objective. Only supports REACH, VIDEO_VIEWS, RF_REACH." }, { "name": "region_codes", "value": "", "type": "query", "description": "Country or region codes." }, { "name": "brand_safety_type", "value": "", "type": "query", "description": "Brand safety type. Default value: STANDARD_INVENTORY. Enum values: EXPANDED_INVENTORY: Use TikTok's brand safety solution. Expanded inventory means that your ads will appear next to content where most inappropriate content has been removed, and may contain some mature themes. In the next API version, EXPANDED_INVENTORY will replace NO_BRAND_SAFETY and will be the default brand safety option. STANDARD_INVENTORY: Use TikTok's brand safety solution. Standard inventory means that ads will appear next to content that is appropriate for most brands. LIMITED_INVENTORY: Use TikTok's brand safety solution. Limited inventory means that your ads will not appear next to content that contains mature themes. Note: Pre-bid first-party Brand Safety solutions for APP_PROMOTION, WEB_CONVERSIONS, TRAFFIC, LEAD_GENERATION objectives in Auction ads, and pre-bid third-party brand safety solutions are currently allowlist-only features. If you would like to access them, please contact your TikTok representative. See Brand safety to learn about the supported advertising objectives for pre-bid Brand Safety filtering." }, { "name": "rf_campaign_type", "value": "", "type": "query", "description": "Note: When objective_type is specified as RF_REACH, use this field to set the campaign as a TikTok Pulse campaign, then you can get available premium contextual tags. Do not pass in this field when objective_type is not specified as RF_REACH. Enum values: STANDARD (Reach & Frequency campaign), PULSE（TikTok Pulse campaign）" }, { "name": "Access-Token", "value": "", "type": "query", "description": "Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)." } ] }, "docs": "Get available contextual tags [Tool Contextual_tag Get](https://ads.tiktok.com/marketing_api/docs?id=1747747118654465)" }, { "info": { "name": "Get details of contextual tags [Tool Contextual_tag Info](https://ads.tiktok.com/marketing_api/docs?id=1747747180830722)", "type": "http" }, "http": { "method": "GET", "url": "https://business-api.tiktok.com/open_api/v1.3/tool/contextual_tag/info/", "params": [ { "name": "advertiser_id", "value": "", "type": "query", "description": "Advertiser ID." }, { "name": "contextual_tag_ids", "value": "", "type": "query", "description": "Contextual tag IDs." }, { "name": "Access-Token", "value": "", "type": "query", "description": "Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)." } ] }, "docs": "Get details of contextual tags [Tool Contextual_tag Info](https://ads.tiktok.com/marketing_api/docs?id=1747747180830722)" }, { "info": { "name": "Get targeting hashtags by ID [Tool Hashtag Get](https://ads.tiktok.com/marketing_api/docs?id=1736280889167874)", "type": "http" }, "http": { "method": "GET", "url": "https://business-api.tiktok.com/open_api/v1.3/tool/hashtag/get/", "params": [ { "name": "advertiser_id", "value": "", "type": "query", "description": "Advertiser ID" }, { "name": "keyword_ids", "value": "", "type": "query", "description": "List of keyword IDs" }, { "name": "Access-Token", "value": "", "type": "query", "description": "Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)." } ] }, "docs": "Get targeting hashtags by ID [Tool Hashtag Get](https://ads.tiktok.com/marketing_api/docs?id=1736280889167874)" }, { "info": { "name": "Search for targeting hashtags [Tool Hashtag Recommend](https://ads.tiktok.com/marketing_api/docs?id=1736271339521025)", "type": "http" }, "http": { "method": "GET", "url": "https://business-api.tiktok.com/open_api/v1.3/tool/hashtag/recommend/", "params": [ { "name": "advertiser_id", "value": "", "type": "query", "description": "Advertiser ID." }, { "name": "keywords", "value": "", "type": "query", "description": "Keywords that you want to get recommended hashtags for. If you specify multiple unrelated keywords and set operator to AND, it is possible that no recommended hashtags are returned. Max size: 10." }, { "name": "operator", "value": "", "type": "query", "description": "The operator to be used between the keywords. Enum values: AND: Recommended hashtags will be generated based on all the keywords specified in keywords. OR: Recommended hashtags will be generated separately for each individual keyword in keywords. Default value: AND." }, { "name": "Access-Token", "value": "", "type": "query", "description": "Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)." } ] }, "docs": "Search for targeting hashtags [Tool Hashtag Recommend](https://ads.tiktok.com/marketing_api/docs?id=1736271339521025)" }, { "info": { "name": "Get additional interest categories by ID [Tool Interest_keyword Get](https://ads.tiktok.com/marketing_api/docs?id=1763590894544897)", "type": "http" }, "http": { "method": "GET", "url": "https://business-api.tiktok.com/open_api/v1.3/tool/interest_keyword/get/", "params": [ { "name": "advertiser_id", "value": "", "type": "query", "description": "Advertiser ID." }, { "name": "filtering", "value": "", "type": "query", "description": "Filtering conditions." }, { "name": "keyword_query", "value": "", "type": "query", "description": "Information of the additional interest category you want to get. Max size = 50." }, { "name": "Access-Token", "value": "", "type": "query", "description": "Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)." } ] }, "docs": "Get additional interest categories by ID [Tool Interest_keyword Get](https://ads.tiktok.com/marketing_api/docs?id=1763590894544897)" }, { "info": { "name": "Get a TikTok in-app link [Tool Open_url](https://ads.tiktok.com/marketing_api/docs?id=1738457335681026)", "type": "http" }, "http": { "method": "GET", "url": "https://business-api.tiktok.com/open_api/v1.3/tool/open_url/", "params": [ { "name": "advertiser_id", "value": "", "type": "query", "description": "Advertiser ID" }, { "name": "url", "value": "", "type": "query", "description": "Open URL that you want to get the internal link for." }, { "name": "url_type", "value": "", "type": "query", "description": "Type of the open TikTok URL. Enum: USER_PROFILE VIDEO: Video detail page HASHTAG_CHALLENGE: Hashtag challenge page MUSIC: Music page STICKER: Sticker (special effect) page STICKER_SHOOTER: Shoot a video with a sticker (special effect)." }, { "name": "Access-Token", "value": "", "type": "query", "description": "Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)." } ] }, "docs": "Get a TikTok in-app link [Tool Open_url](https://ads.tiktok.com/marketing_api/docs?id=1738457335681026)" }, { "info": { "name": "Get OS versions [Tool Os_version](https://ads.tiktok.com/marketing_api/docs?id=1738308662898689)", "type": "http" }, "http": { "method": "GET", "url": "https://business-api.tiktok.com/open_api/v1.3/tool/os_version/", "params": [ { "name": "advertiser_id", "value": "", "type": "query", "description": "Advertiser ID." }, { "name": "os_type", "value": "", "type": "query", "description": "OS type. Enum values: ANDROID,IOS." }, { "name": "Access-Token", "value": "", "type": "query", "description": "Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)." } ] }, "docs": "Get OS versions [Tool Os_version](https://ads.tiktok.com/marketing_api/docs?id=1738308662898689)" }, { "info": { "name": "Get region calling codes and region codes for phone numbers [Tool Phone_region_code](https://ads.tiktok.com/marketing_api/docs?id=1774488637039618)", "type": "http" }, "http": { "method": "GET", "url": "https://business-api.tiktok.com/open_api/v1.3/tool/phone_region_code/", "params": [ { "name": "advertiser_id", "value": "", "type": "query", "description": "Advertiser ID." }, { "name": "Access-Token", "value": "", "type": "query", "description": "Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)." } ] }, "docs": "Get region calling codes and region codes for phone numbers [Tool Phone_region_code](https://ads.tiktok.com/marketing_api/docs?id=1774488637039618)" }, { "info": { "name": "Obtain details about location targeting tags by ID [Tool Targeting Info](https://ads.tiktok.com/marketing_api/docs?id=1761237001980929)", "type": "http" }, "http": { "method": "POST", "url": "https://business-api.tiktok.com/open_api/v1.3/tool/targeting/info/", "params": [ { "name": "Access-Token", "value": "", "type": "query", "description": "Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Obtain details about location targeting tags by ID [Tool Targeting Info](https://ads.tiktok.com/marketing_api/docs?id=1761237001980929)" }, { "info": { "name": "Get internet service providers [Tool Targeting List](https://ads.tiktok.com/marketing_api/docs?id=1762962378261506)", "type": "http" }, "http": { "method": "GET", "url": "https://business-api.tiktok.com/open_api/v1.3/tool/targeting/list/", "params": [ { "name": "advertiser_id", "value": "", "type": "query", "description": "Advertiser ID." }, { "name": "location_ids", "value": "", "type": "query", "description": "IDs of the locations that you want to get the supported ISP IDs for. Max size: 1000. To find out the list of location IDs, see Location IDs. Note: You need to pass location IDs at the country or region level. To get the available locations and corresponding IDs based on your placement and objective, use the /tool/region/ and the returned level for location IDs at the country or region level will be COUNTRY." }, { "name": "scene", "value": "", "type": "query", "description": "The targeting type that the targeting tags are used for. The allowed enum values: ISP ( Internet Service Provider targeting)." }, { "name": "Access-Token", "value": "", "type": "query", "description": "Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)." } ] }, "docs": "Get internet service providers [Tool Targeting List](https://ads.tiktok.com/marketing_api/docs?id=1762962378261506)" }, { "info": { "name": "Search for location targeting tags [Tool Targeting Search](https://ads.tiktok.com/marketing_api/docs?id=1761236883355649)", "type": "http" }, "http": { "method": "POST", "url": "https://business-api.tiktok.com/open_api/v1.3/tool/targeting/search/", "params": [ { "name": "Access-Token", "value": "", "type": "query", "description": "Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Search for location targeting tags [Tool Targeting Search](https://ads.tiktok.com/marketing_api/docs?id=1761236883355649)" }, { "info": { "name": "Get time zones [Tool Timezone](https://ads.tiktok.com/marketing_api/docs?id=1738455961470977)", "type": "http" }, "http": { "method": "GET", "url": "https://business-api.tiktok.com/open_api/v1.3/tool/timezone/", "params": [ { "name": "advertiser_id", "value": "", "type": "query", "description": "Advertiser ID" }, { "name": "Access-Token", "value": "", "type": "query", "description": "Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)." } ] }, "docs": "Get time zones [Tool Timezone](https://ads.tiktok.com/marketing_api/docs?id=1738455961470977)" }, { "info": { "name": "Get the verification results of a URL [Tool Url_validate](https://ads.tiktok.com/marketing_api/docs?id=1774487686007810)", "type": "http" }, "http": { "method": "GET", "url": "https://business-api.tiktok.com/open_api/v1.3/tool/url_validate/", "params": [ { "name": "advertiser_id", "value": "", "type": "query", "description": "Advertiser ID." }, { "name": "url", "value": "", "type": "query", "description": "The URL that you want to get verification results for." }, { "name": "Access-Token", "value": "", "type": "query", "description": "Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)." } ] }, "docs": "Get the verification results of a URL [Tool Url_validate](https://ads.tiktok.com/marketing_api/docs?id=1774487686007810)" }, { "info": { "name": "Check Value-Based Optimization eligibility [Tool Vbo_status](https://ads.tiktok.com/marketing_api/docs?id=1770016073586753)", "type": "http" }, "http": { "method": "GET", "url": "https://business-api.tiktok.com/open_api/v1.3/tool/vbo_status/", "params": [ { "name": "advertiser_id", "value": "", "type": "query", "description": "Advertiser ID." }, { "name": "objective_type", "value": "", "type": "query", "description": "Advertising objective. Set this field to APP_PROMOTION, WEB_CONVERSIONS, or PRODUCT_SALES. When you set this field to any other objective, vo_status will be NOT_SUPPORT because these objectives are not supported for VBO. For enum values and descriptions, see Objectives. Note: When objective_type is set to PRODUCT_SALES and promotion_type is set to LIVE_SHOPPING or VIDEO_SHOPPING, do not pass in pixel_id or app_id. Otherwise, pass in either pixel_id or app_id." }, { "name": "promotion_type", "value": "", "type": "query", "description": "Promotion type and you can decide where you'd like to promote your products using this field. For enum values, see Enumeration - Promotion Type. Note: When objective_type is set to PRODUCT_SALES and promotion_type is set to LIVE_SHOPPING or VIDEO_SHOPPING, do not pass in pixel_id or app_id. Otherwise, pass in either pixel_id or app_id." }, { "name": "placements", "value": "", "type": "query", "description": "The apps where you want to deliver your ads. Note: Currently, we support PLACEMENT_TIKTOK, PLACEMENT_PANGLE and PLACEMENT_GLOBAL_APP_BUNDLE. For Product Sales campaigns (objective_type = PRODUCT_SALES), only TikTok placement (PLACEMENT_TIKTOK) is supported." }, { "name": "pixel_id", "value": "", "type": "query", "description": "Not supported when objective_type is set to PRODUCT_SALES and promotion_type is set to LIVE_SHOPPING or VIDEO_SHOPPING. Otherwise, pass in either pixel_id or app_id. Pixel ID. When you pass in this field, you need to specify optimization_event at the same time. To get Pixel IDs, use the /pixel/list/ endpoint." }, { "name": "app_id", "value": "", "type": "query", "description": "Not supported when objective_type is set to PRODUCT_SALES and promotion_type is set to LIVE_SHOPPING or VIDEO_SHOPPING. Otherwise, pass in either pixel_id or app_id. The Application ID of the promoted app. To get App IDs, use the /app/list/ endpoint." }, { "name": "optimization_event", "value": "", "type": "query", "description": "Required when pixel_id is passed. Ignored when app_id is passed. Conversion event for the ad group. See Conversion events for more." }, { "name": "ios14_quota_type", "value": "", "type": "query", "description": "Do not pass campaign_type and ios14_quota_type at the same time. If both fields are passed, ios14_quota_type will be ignored. We recommend using campaign_type alone when you specify an iOS 14 Dedicated Campaign. campaign_type as REGULAR_CAMPAIGN or ios14_quota_type as UNOCCUPIED both indicate a non-iOS 14 Dedicated Campaign. campaign_type as IOS14_CAMPAIGN or ios14_quota_type as OCCUPIED both indicate an iOS 14 Dedicated Campaign. Whether the campaign will be counted towards the iOS 14 Dedicated Campaign quota. Enum values: OCCUPIED: The campaign is an iOS 14 Dedicated Campaign. UNOCCUPIED: The campaign is not an iOS 14 Dedicated Campaign." }, { "name": "app_promotion_type", "value": "", "type": "query", "description": "Required when objective_type is APP_PROMOTION. App promotion type. Enum values: APP_INSTALL: Get new users to install your app. APP_RETARGETING: Re-engage existing users to take action in your app. Note: Only the enum value APP_INSTALL can be used in an iOS14 Dedicated Campaign." }, { "name": "store_id", "value": "", "type": "query", "description": "Valid only when objective_type is PRODUCT_SALES. ID of the TikTok Shop. Note: To get the TikTok Shop ID, you can use /bc/asset/get/: When in the response asset_type is TIKTOK_SHOP, the returned asset_id is the TikTok Shop ID." }, { "name": "campaign_app_profile_page_state", "value": "", "type": "query", "description": "Whether to use App Profile Page at the campaign level to optimize delivery. Enum values: ON, OFF. You can use the field only when objective_type is APP_PROMOTION and your campaign is an iOS14 Dedicated Campaign (ios14_quota_type =OCCUPIED). Otherwise, an error will occur." }, { "name": "is_smart_performance_campaign", "value": "", "type": "query", "description": "Whether the campaign is a Smart+ Campaign or not. Enum values: true, false." }, { "name": "budget_optimize_on", "value": "", "type": "query", "description": "Whether to enable Campaign Budget Optimization (CBO). Enum values: true, false. For details about CBO, see Campaign Budget Optimization." }, { "name": "campaign_type", "value": "", "type": "query", "description": "Do not pass campaign_type and ios14_quota_type at the same time. If both fields are passed, ios14_quota_type will be ignored. Campaign type. Enums values: REGULAR_CAMPAIGN: non-iOS 14 Dedicated Campaign. IOS14_CAMPAIGN: iOS 14 Dedicated Campaign. The value IOS14_CAMPAIGN can only be used when: objective_type is PRODUCT_SALES. objective_type is APP_PROMOTION and app_promotion_type is APP_INSTALL." }, { "name": "is_advanced_dedicated_campaign", "value": "", "type": "query" }, { "name": "disable_skan_campaign", "value": "", "type": "query" }, { "name": "bid_align_type", "value": "", "type": "query" }, { "name": "Access-Token", "value": "", "type": "query", "description": "Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)." } ] }, "docs": "Check Value-Based Optimization eligibility [Tool Vbo_status](https://ads.tiktok.com/marketing_api/docs?id=1770016073586753)" } ] }, { "info": { "name": "Ad", "type": "folder" }, "items": [ { "info": { "name": "Submit ad appeal [Smart Plus Ad Appeal]", "type": "http" }, "http": { "method": "POST", "url": "https://business-api.tiktok.com/open_api/v1.3/smart_plus/ad/appeal/", "params": [ { "name": "Access-Token", "value": "", "type": "query", "description": "Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Submit ad appeal [Smart Plus Ad Appeal]" }, { "info": { "name": "Create a new ad [Smart Plus Ad Create]", "type": "http" }, "http": { "method": "POST", "url": "https://business-api.tiktok.com/open_api/v1.3/smart_plus/ad/create/", "params": [ { "name": "Access-Token", "value": "", "type": "query", "description": "Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a new ad [Smart Plus Ad Create]" }, { "info": { "name": "Retrieve ad details [Smart Plus Ad Get]", "type": "http" }, "http": { "method": "GET", "url": "https://business-api.tiktok.com/open_api/v1.3/smart_plus/ad/get/", "params": [ { "name": "advertiser_id", "value": "", "type": "query" }, { "name": "filtering", "value": "", "type": "query" }, { "name": "page", "value": "", "type": "query" }, { "name": "page_size", "value": "", "type": "query" }, { "name": "fields", "value": "", "type": "query" }, { "name": "Access-Token", "value": "", "type": "query", "description": "Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)." } ] }, "docs": "Retrieve ad details [Smart Plus Ad Get]" }, { "info": { "name": "Update ad material status [Smart Plus Ad Material Status Update]", "type": "http" }, "http": { "method": "POST", "url": "https://business-api.tiktok.com/open_api/v1.3/smart_plus/ad/material_status/update/", "params": [ { "name": "Access-Token", "value": "", "type": "query", "description": "Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update ad material status [Smart Plus Ad Material Status Update]" }, { "info": { "name": "Get ad review info [Smart Plus Ad Review Info]", "type": "http" }, "http": { "method": "GET", "url": "https://business-api.tiktok.com/open_api/v1.3/smart_plus/ad/review_info/", "params": [ { "name": "advertiser_id", "value": "", "type": "query" }, { "name": "smart_plus_ad_ids", "value": "", "type": "query" }, { "name": "extra_info_setting", "value": "", "type": "query" }, { "name": "lang", "value": "", "type": "query" }, { "name": "context_info", "value": "", "type": "query" }, { "name": "Access-Token", "value": "", "type": "query", "description": "Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)." } ] }, "docs": "Get ad review info [Smart Plus Ad Review Info]" }, { "info": { "name": "Update ad status [Smart Plus Ad Status Update]", "type": "http" }, "http": { "method": "POST", "url": "https://business-api.tiktok.com/open_api/v1.3/smart_plus/ad/status/update/", "params": [ { "name": "Access-Token", "value": "", "type": "query", "description": "Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update ad status [Smart Plus Ad Status Update]" }, { "info": { "name": "Update an ad [Smart Plus Ad Update]", "type": "http" }, "http": { "method": "POST", "url": "https://business-api.tiktok.com/open_api/v1.3/smart_plus/ad/update/", "params": [ { "name": "Access-Token", "value": "", "type": "query", "description": "Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update an ad [Smart Plus Ad Update]" }, { "info": { "name": "Get material review info [Smart Plus Material Review Info]", "type": "http" }, "http": { "method": "GET", "url": "https://business-api.tiktok.com/open_api/v1.3/smart_plus/material/review_info/", "params": [ { "name": "advertiser_id", "value": "", "type": "query" }, { "name": "ad_material_ids", "value": "", "type": "query" }, { "name": "extra_info_setting", "value": "", "type": "query" }, { "name": "lang", "value": "", "type": "query" }, { "name": "context_info", "value": "", "type": "query" }, { "name": "Access-Token", "value": "", "type": "query", "description": "Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)." } ] }, "docs": "Get material review info [Smart Plus Material Review Info]" } ] }, { "info": { "name": "Adgroup", "type": "folder" }, "items": [ { "info": { "name": "Create a new ad group [Smart Plus AdGroup Create]", "type": "http" }, "http": { "method": "POST", "url": "https://business-api.tiktok.com/open_api/v1.3/smart_plus/adgroup/create/", "params": [ { "name": "Access-Token", "value": "", "type": "query", "description": "Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a new ad group [Smart Plus AdGroup Create]" }, { "info": { "name": "Retrieve ad group details [Smart Plus AdGroup Get]", "type": "http" }, "http": { "method": "GET", "url": "https://business-api.tiktok.com/open_api/v1.3/smart_plus/adgroup/get/", "params": [ { "name": "advertiser_id", "value": "", "type": "query" }, { "name": "filtering", "value": "", "type": "query" }, { "name": "page", "value": "", "type": "query" }, { "name": "page_size", "value": "", "type": "query" }, { "name": "fields", "value": "", "type": "query" }, { "name": "Access-Token", "value": "", "type": "query", "description": "Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)." } ] }, "docs": "Retrieve ad group details [Smart Plus AdGroup Get]" }, { "info": { "name": "Update ad group status [Smart Plus AdGroup Status Update]", "type": "http" }, "http": { "method": "POST", "url": "https://business-api.tiktok.com/open_api/v1.3/smart_plus/adgroup/status/update/", "params": [ { "name": "Access-Token", "value": "", "type": "query", "description": "Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update ad group status [Smart Plus AdGroup Status Update]" }, { "info": { "name": "Update an ad group [Smart Plus AdGroup Update]", "type": "http" }, "http": { "method": "POST", "url": "https://business-api.tiktok.com/open_api/v1.3/smart_plus/adgroup/update/", "params": [ { "name": "Access-Token", "value": "", "type": "query", "description": "Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update an ad group [Smart Plus AdGroup Update]" } ] } ], "bundled": true }