- Category: marketing
- Auth: OAUTH2
- Composio-managed OAuth available? Yes
- Tools: 404
- Triggers: 0
- Slug:
TIKTOK_ADS - Version: 20261103_00
Tools
Add a partner to a BC
Add a partner to a BC
TIKTOK_ADS_ADD_BC_PARTNERAdd another Business Center as a partner and optionally share advertiser or catalog assets with it.Input Parameters
AD_PROMOTE when applicable.ANALYST when applicable.Output
Appeal a rejection
Appeal a rejection
Appeal Smart+ Ad
Appeal Smart+ Ad
Apply or Disconnect a Custom Audience
Apply or Disconnect a Custom Audience
Assign an asset
Assign an asset
Assign Members to a Child Business Center
Assign Members to a Child Business Center
Assign TikTok Account To Advertiser
Assign TikTok Account To Advertiser
Bind an event source to a catalog
Bind an event source to a catalog
Bind/Unbind rules
Bind/Unbind rules
Cancel Custom Audience Sharing
Cancel Custom Audience Sharing
Cancel asynchronous report task
Cancel asynchronous report task
Cancel the R&F ad order
Cancel the R&F ad order
TIKTOK_ADS_CANCEL_RF_ORDERCancel the R&F ad order. This operation is destructive or irreversible; confirm exact disposable targets before calling. This operation can affect billing, credit, invoices, budgets, contracts, or payments; require explicit approval and an isolated account.Input Parameters
Output
Get Change Log Download Task Result
Get Change Log Download Task Result
Check Advertiser Term Status
Check Advertiser Term Status
Check the statuses of words
Check the statuses of words
Check the status of a blocked-word export task
Check the status of a blocked-word export task
Get Manual Campaign Copy Task Results
Get Manual Campaign Copy Task Results
Check Change Log Download Task
Check Change Log Download Task
Get the status of a comment export task
Get the status of a comment export task
Check File Names
Check File Names
Check TikTok Shop GMV Max Availability
Check TikTok Shop GMV Max Availability
Check MMM Data Request
Check MMM Data Request
Check a lead download task
Check a lead download task
TIKTOK_ADS_CHECK_PAGE_LEAD_TASKPoll an existing TikTok lead download task. Provide the task ID and exactly one owning advertiser or Business Center form-library context; the polling operation does not require the original ad or Instant Form target.Input Parameters
Output
Check asynchronous report task
Check asynchronous report task
Check Smart+ Campaign Copy Task
Check Smart+ Campaign Copy Task
Check UnionPay Verification Requirement
Check UnionPay Verification Requirement
Check Value-Based Optimization eligibility
Check Value-Based Optimization eligibility
TIKTOK_ADS_CHECK_VBO_ELIGIBILITYCheck VBO bidding eligibility for a proposed campaign configuration; some options require allowlisting.Input Parameters
Output
Sign Terms
Sign Terms
Get a TikTok in-app link
Get a TikTok in-app link
Create ads
Create ads
Create an ad group
Create an ad group
TIKTOK_ADS_CREATE_ADGROUPCreate an ad group, disabled by default unless explicitly enabled; availability may depend on account entitlement or allowlisting. Starting January 1, 2027, creation under non-Search Legacy Manual Flow campaigns with Sales, App Promotion, or Lead Generation objectives is no longer supported.Input Parameters
app_id by using the /app/list/ endpoint. Required in the following use cases: When objective_type is APP_PROMOTION and app_promotion_type is APP_RETARGETING (App retargeting).When objective_type is APP_PROMOTION , app_promotion_type is APP_INSTALL(App install) or APP_PREREGISTRATION (App Pre-registration), and it is not an iOS14 Dedicated Campaign. Note: You cannot specify an App that has not activated the SAN module on your MMP through this field to create ad groups. To ensure that TikTok SAN integration is enabled for your App, see How to transition to SAN for existing apps and How to integrate to SAN for new apps.budget_optimize_on = TRUE) is enabled. For how to configure budget settings, see Budget. To directly see the daily budget value range for a currency, see Currency-Daily budget value range.GENDER_FEMALE,GENDER_MALE,GENDER_UNLIMITED.PACING_MODE_SMOOTH and PACING_MODE_FAST. For PACING_MODE_SMOOTH, the budget is allocated evenly within the scheduled time. PACING_MODE_FAST would consume budget and produce results as soon as possible. When Campaign Budget Optimization (budget_optimize_on) is on, your setting will be ignored and it will be set as PACING_MODE_SMOOTH. Otherwise, this field is required.true. In regulated regions, HFSS ads must only be targeted to users aged 18 or over. You can set this field to true when your targeting locations include locations in the UK, Australia, New Zealand, and the European Union. Supported values: true,false. Default value: false.location_ids at the same time. IDs of the Internet service providers (ISP) that you want to target. You can use /tool/targeting/list/ to get the ISP IDs that you can target for a location ID. Note: When you pass in isp_ids, you cannot set the placement as Global App Bundle only (placements =PLACEMENT_GLOBAL_APP_BUNDLE).budget_optimize_on = TRUE). For enum values, see Enumeration - Bidding Strategy. Note For new ad groups created under one CBO campaign, this field should be the same as the first ad group.optimization_goal is set to CONVERT or VALUE. Not supported when optimization_goal is not set to CONVERT or VALUE. Pixel ID. To obtain the list of Pixel IDs within your ad account, use /pixel/list/.deep_bid_type is VO_MIN_ROAS. ROAS goal for Value Optimization. Value range: For in-app advertising scenarios (objective_type is APP_PROMOTION, optimization_goal is VALUE, and optimization_event is AD_REVENUE_VALUE): 0.01-10.For Product Shopping Ads with product source as TikTok Shop (shopping_ads_type is PRODUCT_SHOPPING_ADS and product_source is STORE): 0.01-20.For other scenarios: 0.01-1,000.shopping_ads_type is VIDEO and product_source is STORE.shopping_ads_type is PRODUCT_SHOPPING_ADS and product_source is STORE. Optional when shopping_ads_type is LIVE.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.bid_type is BID_TYPE_CUSTOM and billing_event is CPC, CPM, or CPV. Bid price. The average cost per result that you want to achieve (for Cost Cap bidding strategy). When Campaign Budget Optimization (budget_optimize_on) is on, we suggest that you set the same bid value for all ad groups in the campaign. bid_price needs to be lower than budget set at the campaign level and ad group level. See Bidding-Bidding limits to learn more about the bid verification mechanism.frequency_schedule, controls how often people see your ad (only available for REACH ads). The below conditions should be both met:1 1 For example, frequency = 2 & frequency_schedule = 3 means “show ads no more than twice every 3 day”.AGE_13_17) in the US, Latin America, the European Economic Area, the UK, Switzerland, or Canada will not be allowed. See New age restrictions for ads on TikTok to learn more. If you use targeting options that are not supported for the age group 13-17 in the US , Latin America, the European Economic Area, the UK, Switzerland, or Canada and leave the age_groups field unspecified or set it as [], the field will default to ["AGE_18_24", "AGE_25_34", "AGE_35_44", "AGE_45_54", "AGE_55_100"]. Note: If the ad group targets the age group 13-17 (AGE_13_17) in the US, Latin America, the European Economic Area, the UK, Switzerland, or Canada and you typically leave the age_groups field unspecified or set it as [], we recommend that you explicitly specify the exact age groups that you want to target, such as AGE_18_24, in the field.sales_destination is WEB_AND_APP at the campaign level. Details of the app or apps to promote. Max size: 2. You can specify any of the following in this field:an Android appan iOS appan Android app and an iOS appproduct_source is CATALOG or STORE, this field is required. When shopping_ads_type is LIVE, the parameters catalog_id, catalog_authorized_bc_id, store_id, store_authorized_bc_id are optional. If you specify a TikTok Shop through these parameters for your Live Shopping Ads, sales of products belonging to the TikTok Shop will be reported. If you don’t specify a TikTok Shop, sales of products showcased in the TikTok account (identity_id) will be reported. Catalog ID. When product_source is CATALOG, set this field to the catalog that you want to promote products from. When product_source is STORE, set this field to the catalog bound to the TikTok Shop that you want to promote products from.You can use /store/list/ to get the catalog_id, store_id and store_authorized_bc_id for available stores under an ad account. Note: Starting June 30th, 2024, when product_source is STORE, you will no longer need to pass catalog_id because it will be ignored.placement_type=PLACEMENT_TYPE_NORMAL; ignored and system-selected for PLACEMENT_TYPE_AUTOMATIC. Supported: PLACEMENT_TIKTOK, PLACEMENT_PANGLE, PLACEMENT_GLOBAL_APP_BUNDLE; do not use deprecated PLACEMENT_TOPBUZZ or PLACEMENT_HELO. Placements cannot be updated after creation. Global App Bundle supports Brazil, Indonesia, Vietnam, Philippines, Thailand, Malaysia, Mexico, Saudi Arabia, and Japan; it does not support optimization_goal=TRAFFIC_LANDING_PAGE_VIEW, and Auction Reach use is allowlist-only. With objective_type=REACH, Global App Bundle cannot be combined with contextual_tag_ids; when it is the only placement, brand_safety_type=THIRD_PARTY is invalid. For objective_type=PRODUCT_SALES, use only PLACEMENT_TIKTOK.adgroup_name and different request_id. It also supports idempotency to prevent you from sending the same request twice within 10 seconds. If you retry requests with the same request ID multiple times within 10 seconds, then only one will succeed. It is different from the request_id returned in the response parameters, which is used to uniquely identify an HTTP request. The value should be a string representation of a 64-bit integer number. Example: 123456789SEVEN_DAYS (day 7, default) or ZERO_DAY (day 0). For Minimum ROAS, selects the target ROAS window and the system aims for average ROAS at or above the target. For Highest Value, selects the value-maximization window and the system aims to spend the budget fully. VBO availability is scenario-dependent and allowlist-only; day 0/day 7 VBO IAA or IAP in Advanced Dedicated Campaign and Android scenarios is also allowlist-only. Once set, this field cannot be updated.BUDGET_MODE_TOTAL: lifetime budget and requires schedule_type=SCHEDULE_START_END plus schedule_end_time. BUDGET_MODE_DYNAMIC_DAILY_BUDGET: weekly average; daily spend <=125% of average and weekly spend <=7 times average. Use it for non-lifetime budgets with TRAFFIC, APP_PROMOTION, WEB_CONVERSIONS, LEAD_GENERATION, Video Shopping PRODUCT_SALES, REACH, VIDEO_VIEWS, or ENGAGEMENT; the last three are allowlist-only. BUDGET_MODE_DAY: daily budget; schedule_type may be SCHEDULE_START_END or SCHEDULE_FROM_NOW, but dynamic daily is recommended for REACH, VIDEO_VIEWS, and ENGAGEMENT.in_use field for the carrier is true.shopping_ads_type is VIDEO and product_source is SHOWCASE or shopping_ads_type is LIVE. Identity ID.saved_audience_id supplies targeting, provide location_ids, zipcode_ids, or both; their combined location/zip/postal ID count cannot exceed 3,000. Get IDs as geo_id with geo_type=ZIP_CODE from /tool/targeting/search/; use /tool/targeting/info/ for details. ZIP codes support the US; postal codes support Canada, Brazil, Indonesia, Thailand, and Vietnam, with the latter four allowlist-only. Not supported with special_industries or objective_type=RF_REACH; placements must include PLACEMENT_TIKTOK. Locations cannot overlap (for example, US and California). After initially targeting the US, updates may change to other US locations but cannot remove all US locations and leave only non-US countries.next_day_retention is specified.saved_audience_id supplies targeting, set location_ids, zipcode_ids, or both. IDs of the locations that you want to target. Max size: 3,000. If you provide both location_ids and zipcode_ids, the combined total of location IDs, zip code IDs, and postal code IDs cannot exceed 3,000 per ad group. To get the available locations and corresponding IDs based on your placement and objective, use the /tool/targeting/search/ or /tool/region/ endpoint. To get the list of location IDs, see Location IDs. Note: Overlapping targeted locations are not supported. For instance, you cannot target the U.S. and the state of California at the same time. If you target locations in the US via location_ids or zipcode_ids during ad group creation, you can subsequently update those IDs to other US locations but you cannot remove all US locations to target only non-US countries.messaging_app_type is WHATSAPP or ZALO. The WhatsApp or Zalo phone number. For WhatsApp, use the same WhatsApp phone number connected to the Messagement Management Tool (MMT). Note: Once set, this field cannot be updated.objective_type is TRAFFIC or APP_PROMOTION. For details, see Audience Rules.app_promotion_type is APP_RETARGETING at the campaign level. Not supported when app_promotion_type is not set to APP_RETARGETING at the campaign level. App retargeting audience type. Enum value:NEW_CUSTOM_AUDIENCE (retargeting custom audience). If you want to specify an empty retargeting custom audience for your App Retargeting ads, do not pass audience_ids and excluded_audience_ids. If you want to specify a non-empty retargeting custom audience for your App Retargeting ads, you can specify an Include Audience via audience_ids, or an Exclude Audience via excluded_audience_ids , or both simultaneously. If both audience_ids and excluded_audience_ids are specified, they cannot contain the same IDs.budget_optimize_on = true) and optimization_goal is VALUE. Enum values: VO_MIN_ROAS (allowlisted), VO_HIGHEST_VALUE (allowlisted). For details, see Enumeration - Deep Event Bidding Strategy. Note: When secondary_optimization_event is specified, you need to pass in deep_bid_type at the same time.shopping_ads_type is VIDEO and product_source is SHOWCASE or shopping_ads_type is LIVE. Identity type. Enum values: AUTH_CODE (Authorized Post User), TT_USER (TikTok Business Account User), BC_AUTH_TT(The TikTok account that a Business Center is authorized to access). See Identities for details.SCHEDULE_START_END or SCHEDULE_FROM_NOW. If you choose SCHEDULE_START_END, you need to specify a start time and an end time. If you choose SCHEDULE_FROM_NOW, you only need to specify a start time and the end time will be automatically set to 10 years later than the start time.If budget_mode is BUDGET_MODE_TOTAL, this field must be set to SCHEDULE_START_END.PLACEMENT_TYPE_AUTOMATIC: Automatic placement. TikTok’s ad system will use smart calculations to give you the best combination of ad placements across all apps.PLACEMENT_TYPE_NORMAL: Select placement. By selecting your placement manually, you’ll be able to choose the apps to deliver your ads on. Default value: PLACEMENT_TYPE_NORMAL. Note: placement_type cannot be updated after the ad group has been created.If you set this field to PLACEMENT_TYPE_AUTOMATIC, the actual supported placements will be shown in the returned placements. For instance, if the actual supported placement is TikTok only, the returned placements value will be PLACEMENT_TIKTOK.UNSET, CATALOG (catalog), STORE (TikTok Shop), or SHOWCASE (TikTok Showcase). For Product Shopping Ads, use STORE. For Video Shopping Ads, campaign_product_source=CATALOG permits only CATALOG; campaign_product_source=STORE permits STORE or SHOWCASE. Without a campaign-level source, all ad groups in a campaign must use either only CATALOG or only the STORE/SHOWCASE family. If historical ad groups mix CATALOG with STORE or SHOWCASE, no new ad group can be created in that campaign.objective_type) for your campaign is NOT set as REACH, VIDEO_VIEWS, or ENGAGEMENT. For enum values, see Enumeration - Promotion Type. Note: If objective_type is ENGAGEMENT at the campaign level, you can only use EXTERNAL_OR_DISPLAY in this field.false. The value trueis valid when the conditions below are all met:objective_type at the campaign level is set as one of the following objectives: APP_PROMOTION, WEB_CONVERSIONS, REACH, TRAFFIC, VIDEO_VIEWS, ENGAGEMENT, LEAD_GENERATION. Placement: placement_type= PLACEMENT_TYPE_AUTOMATIC orplacement_type= PLACEMENT_TYPE_NORMAL, and placements = PLACEMENT_TIKTOKALL, HIGH. If it is set to HIGH, you can target high spending users who typically spend more on purchases on TikTok ads than average users. Note:This field does not support the advertising objectives PRODUCT_SALES and RF_REACH at the campaign level. See Advertising objectives for details. This field supports Automatic Placement and Select Placement with TikTok included. Therefore, you need to set placement_type to PLACEMENT_TYPE_AUTOMATIC, or include PLACEMENT_TIKTOK in the value of placements. Note that if you specify Pangle as a placement, the spending power targeting won’t take effect on Pangle. When auto_targeting_enabled is true at the ad group level, then spending_power will be automatically set to ALL.EVERYTIME (Each Purchase)/ NONE (Unique Purchase). You can get statistic_type values suitable for your app event by using the /app/optimization_event/ endpoint.UNSET targets iOS 14.4 or earlier; IOS14_MINUS targets before 14.0; IOS14_PLUS targets 14.5+ in Dedicated Campaigns; ALL targets 14.5+ only for iOS App Retargeting or catalog Video Shopping retargeting optimized to app. campaign_type=IOS14_CAMPAIGN requires IOS14_PLUS and allows at most two active ad groups. For IOS14_PLUS, use an iOS app_id, operating_systems=["IOS"], compatible min_ios_version, and optimization_goal in CLICK, INSTALL, IN_APP_EVENT, VALUE; omit min_android_version, shopping_ads_retargeting_type, and shopping_ads_retargeting_actions_days, and do not use ad-level deeplink_type=DEFERRED_DEEPLINK. Once IOS14_PLUS, it cannot change. App Retargeting 14.5+ requires ALL and min_ios_version>=14.5; omit this field for 14.4 or earlier. ALL is forced for iOS App Retargeting (APP_RETARGETING + APP_IOS) and iOS catalog Video Shopping app retargeting (VIDEO, CATALOG, APP_IOS, retargeting not OFF). Otherwise defaults to UNSET.ios14_targeting is specified. Minimum iOS version. For enum values, see Enumeration - Minimum iOS Version.is_search_campaign is true at the campaign level).Not supported for non-Search Ads Campaigns (is_search_campaign is false at the campaign level). A list of search keywords, that is, words or phrases that are used to match your ads with the terms people are searching for. Max size: 1,000. To confirm whether a campaign is a Search Ads Campaign, call /campaign/get/ and check the is_search_campaign returned for the campaign. To learn more about Search Ads Campaigns, see Create Search Ads Campaigns. Note: For each ad group, you can configure a maximum of 1,000 search keywords.CPV(Cost per One View) when objective_type is VIDEO_VIEW. How you calculate and measure Cost per View. Note:bid_display_mode cannot be updated after creation. You don’t need to specify this field if your objective_type is not VIDEO_VIEW. The enum value of CPMV is deprecated in v1.3.is_active = True in the response of /tool/device_model/) can be used to create ads. Note: Device model (device_model_ids) and device price (device_price_ranges) cannot be set at the same time.TOP5(Top 5% of ZIP codes), TOP10(Top 10% of ZIP codes), TOP10_25(Top 10% -25% of ZIP codes), TOP25_50(Top 25% - 50% of ZIP codes). Note: It only supports the ad objectives for Auction ads. See Advertising objectives for details. It is only applicable to the TikTok Placement in the US.DISABLE is the safe default so the new ad group does not start delivery or spend. Pass ENABLE explicitly to make it eligible for delivery. To update its status after creation, use /adgroup/status/update/.placements=["PLACEMENT_TIKTOK"]; default NO_BRAND_SAFETY. NO_BRAND_SAFETY: full inventory, including possible mature themes; deprecated next version. EXPANDED_INVENTORY: most inappropriate and mature content removed; replaces NO_BRAND_SAFETY next version. STANDARD_INVENTORY: content appropriate for most brands. LIMITED_INVENTORY: no mature themes. THIRD_PARTY: third-party filtering and requires brand_safety_partner. Use /tool/region/ for eligible regions. First-party filtering for Auction APP_PROMOTION, WEB_CONVERSIONS, TRAFFIC, LEAD_GENERATION, and PRODUCT_SALES, and all third-party filtering, are allowlist-only.optimization_goal) is INSTALL, the default value is ONE_DAY_CLICK_OR_ONE_DAY_VIEW. If the optimize goal(optimization_goal) is IN_APP_EVENT, the default value is SEVEN_DAY_CLICK_OR_ONE_DAY_VIEW. For enum values, see Enumeration - Conversion Window.is_lhf_compliance to true, you confirm that any food or drink products you advertise on TikTok in the UK comply with the 2024 Less Healthy Foods Regulations and all other applicable laws. Supported values: true,false. Default value: false. Note: Starting January 1st, 2026, when your ad targets locations in the UK and is_hfss is true, is_lhf_compliance is required and must be set to true.ANDROID, IOS. This field is required in two scenarios: objective_type is APP_PROMOTION``objective_type is TRAFFIC and promotion_type is APP_IOS or APP_ANDROIDbilling_event. For Install with in-app event, use INSTALL plus a valid secondary_optimization_event, with normal placement containing only PLACEMENT_PANGLE, PLACEMENT_GLOBAL_APP_BUNDLE, or both. Since November 30, 2024, new/copied APP_PROMOTION ad groups cannot use Install with in-app event on PLACEMENT_TIKTOK or automatic placement; existing groups are unaffected. For LEAD_GEN_CLICK_TO_TT_DIRECT_MESSAGE, LEAD_GEN_CLICK_TO_SOCIAL_MEDIA_APP_MESSAGE, or LEAD_GEN_CLICK_TO_CALL, default is CLICK. VIDEO_VIEW is no longer valid; for campaign objective_type=VIDEO_VIEWS, use ENGAGED_VIEW or ENGAGED_VIEW_FIFTEEN. New ad groups in one CBO campaign must match the first ad group’s goal. Consult Optimization Goal enumerations for valid values and CBO compatibility.messaging_app_type is WHATSAPP or ZALO. The region code for the WhatsApp or Zalo phone number. Example: US. To obtain the region code (phone_region_code) and region calling code (phone_region_calling_code) for the region that is associated with a specific phone number, use /tool/phone_region_code/. Note: Once set, this field cannot be updated.specical_industries, objective_type is not PRODUCT_SALES, TikTok placement is selected, and auto_targeting_enabled is not true. The Saved Audience and ad group must have the same advertiser ID. Do not also pass targeting options already contained in the Saved Audience. Its device settings must not conflict with the ad group, such as Android versus ios14_targeting=IOS14_PLUS, or iOS versus an Android app. Use /dmp/saved_audience/list/ to diagnose targeting conflicts. Any saved age_groups must satisfy current age restrictions.schedule_type is SCHEDULE_START_END or budget_mode is BUDGET_MODE_TOTAL. Schedule end time (UTC+0), in the format of "YYYY-MM-DD HH:MM:SS". The end time cannot be later than "2038-01-01 00:00:00".objective_type is PRODUCT_SALES. Shopping ads type. Enum values: VIDEO: Video Shopping Ads.LIVE: Live Shopping Ads.PRODUCT_SHOPPING_ADS: Product Shopping Ads. To find out the introduction to different Shopping Ads types and the steps of creating Video Shopping Ads, Live Shopping Ads, and Product Shopping Ads, see Create Shopping Ads.REACH and VIDEO_VIEWS as objectives (objective_type) at the campaign level. Not supported when brand_safety_type is set to THIRD_PARTY.frequency, controls how often people see your ad (only available for REACH ads). See frequency fields for more.promotion_type=LEAD_GEN_CLICK_TO_SOCIAL_MEDIA_APP_MESSAGE; required for optimization_goal=CONVERSATION, where ZALO, LINE, and IM_URL are not allowed. For optimization_goal=CLICK, defaults to IM_URL. Values: MESSENGER requires a Facebook Page ID in messaging_app_account_id; LINE requires a LINE Business ID there; WHATSAPP or ZALO requires phone_region_code, phone_region_calling_code, and phone_number; IM_URL uses a custom instant-messaging URL. Once set, this field cannot be updated.placements is PLACEMENT_PANGLE and secondary_optimization_event is NEXT_DAY_OPEN. Day 2 retention ratio. Formula: next_day_retention = conversion_bid_price/deep_cpa_bid. Value range: (0,1]. Note: If you want to use this field, please pass in conversion_bid_price, deep_cpa_bid, and next_day_retention at the same time, and make sure the value of them meets the calculation formula. Otherwise there might be unexpected errors.pixel_id is specified.pixel_id is not specified and optimization_goal is IN_APP_EVENT or VALUE. Conversion event. For the supported app and pixel events, see Conversion events. To find out the supported events for your app, use /app/optimization_event/. NoteFor new ad groups created under one CBO campaign, this field should be the same as the first ad group.When optimization_goal is PAGE_VISIT, optimization_event will be automatically set as PAGE_VISIT."YYYY-MM-DD HH:MM:SS". The start time can be up to 12 hours earlier than the current time, but cannot be later than "2028-01-01 00:00:00".brand_safety_type is THIRD_PARTY, and placements needs to be set to ["PLACEMENT_TIKTOK"]. Brand safety partner. Enum values: IAS, OPEN_SLATE(The partner is named DoubleVerify on TikTok Ads Manager because the partner has been acquired by DoubleVerify). To get the countries and regions that your ads can be deployed to based on your brand safety settings, use the /tool/region/ endpoint. You need to pass in the brand safety type and brand safety partner. Note: Pre-bid third-party brand safety solutions are currently allowlist-only features. If you would like to access them, please contact your TikTok representative. Once set, this field cannot be modified.bid_type is BID_TYPE_CUSTOM and billing_event is OCPM. Where you can set a target cost per conversion for oCPM(Optimized Cost per Mille). conversion_bid_price needs to be lower than budget set at the campaign level and ad group level. See Bidding-Bidding limits to learn more about the bid verification mechanism.pixel_id or app_id is specified.A Custom Conversion has been configured for the pixel_id or app_id.The optimization_goal is set to CONVERT or IN_APP_EVENT.The parameter optimization_event is specified and matches the Standard Event associated with the Custom Conversion.The status of the Custom Conversion is Active or No recent activity. To obtain the list of Custom Conversions associated with a Pixel or an App, use /custom_conversion/list/. To confirm the eligibility of the Custom Conversion for ad group creation:Ensure the returned optimization_event matches the optimization_event specified during ad group creation.Ensure the activity_status is NO_RECENT_ACTIVITY or ACTIVE.promotion_type=LEAD_GEN_CLICK_TO_SOCIAL_MEDIA_APP_MESSAGE, optimization_goal=CONVERSATION, and the selected Messenger or WhatsApp account matches no existing event set. Call /ctm/message_event_set/get/: if matched_event_set exists, this field is ignored and auto-filled with that unique set; if empty, choose an ID from message_event_set_list. Messenger is identified by messaging_app_account_id; WhatsApp by phone_region_code, phone_region_calling_code, and phone_number. Once set, it cannot be updated.objective_type REACH, VIDEO_VIEWS, or ENGAGEMENT, with placement_type=PLACEMENT_TYPE_NORMAL and placements=["PLACEMENT_TIKTOK"]. Values: IN_FEED, SEARCH_FEED, TIKTOK_LITE, LEMON8. If provided, include IN_FEED. LEMON8 requires REACH; TIKTOK_LITE requires Japan or South Korea in location_ids. SEARCH_FEED, TIKTOK_LITE, and Auction Reach LEMON8 are allowlist-only and cannot use brand_safety_type=THIRD_PARTY. Reach with LEMON8 cannot specify contextual_tag_ids. TIKTOK_LITE cannot be used for creation or copying after July 19, 2025; if already used, Japan and South Korea cannot both be removed. Once set, this field cannot be updated. Interactive add-ons: SEARCH_FEED supports only Display Card; TIKTOK_LITE supports only Display Card, Countdown Sticker, and Gift Code Sticker, subject to objective compatibility.objective_type at the campaign level is LEAD_GENERATION. The promotion type for Lead Generation objective. You can find out how to create lead generation ads in Lead Generation Ads. Enum values: INSTANT_PAGE:Instant Form. To create a fast-loading in-app TikTok Instant Form to collect more leads. EXTERNAL_WEBSITE:Website Form. To use a landing page that has the Website Form or the TikTok Instant Page that redirects to the website with the Website Form to collect more leads. Once this field is set to EXTERNAL_WEBSITE and optimization_goal is CLICK, do not pass pixel_id and optimization_event.APP_PROMOTION, WEB_CONVERSIONS, TRAFFIC, or LEAD_GENERATION with automatic placement, or normal placement including PLACEMENT_TIKTOK, it defaults to true; omit/set true to enable or set false to disable. It is forced to false and cannot be true for Search Ads campaigns (is_search_campaign=true) with WEB_CONVERSIONS, TRAFFIC, or LEAD_GENERATION; for other objectives; or for normal placement without PLACEMENT_TIKTOK.app_package_id field returned by Get Pangle block list. It only takes effect when Pangle placement is selected.objective_type is REACH, VIDEO_VIEWS, ENGAGEMENT, RF_REACH, APP_PROMOTION,WEB_CONVERSIONS,TRAFFIC, or LEAD_GENERATION. At the ad group level: placements is set to ["PLACEMENT_TIKTOK"]. brand_safety_type is set to STANDARD_INVENTORY or LIMITED_INVENTORY.Content exclusion category IDs. You can use /tool/content_exclusion/get/ to get a list of content category IDs (excluded_category_list) that can be excluded from being displayed next to your ads.creative_material_mode = CUSTOM) to ensure a smoother migration journey. See here to find out how to create Smart Creative ads.UNSET: To not use TikTok Instant Page. TIKTOK_NATIVE_PAGE: To use TikTok Instant Page. If this field is set to TIKTOK_NATIVE_PAGE at the ad group level, pixel_id is not supported and you need to specify a TikTok Instant Page through page_id at the ad level.To learn about how to create App Pre-registration ads, refer to here. Note: When app_promotion_type at the campaign level is APP_PREREGISTRATION, this field is required.true, false. To learn more about Smart audience and how to turn on Smart audience, see Smart Targeting.store_id is passed. ID of the Business Center that is authorized to access the store (store_id).UNSET: Unset. EVERY: Every. To count multiple events from someone as separate conversions. ONCE: Once. To count multiple events from someone as 1 conversion. To learn about the allowed values of this field for different advertising objective scenarios, refer to Attribution window and event count. Note: If you don’t manually pass click_attribution_window, engaged_view_attribution_window, view_attribution_window and attribution_event_count, then default settings, if any, will be used. To confirm whether a default setting is used when you don’t manually pass this field, use /adgroup/get/. Once set, this field cannot be updated.shopping_ads_retargeting_type is LAB3, you need to pass in either included_custom_actions or excluded_custom_actions. The custom action that you want to use as “Exclude” conditions for filtering out the shopping ads audiences to be retargeted.shopping_ads_retargeting_type is LAB3, you need to pass in either included_custom_actions or excluded_custom_actions. The custom action that you want to use as “Include” conditions for filtering out the shopping ads audiences to be retargeted.objective_type is REACH, VIDEO_VIEWS or ENGAGEMENT. At the ad group level:placements is set to ["PLACEMENT_TIKTOK"].brand_safety_type is set to STANDARD_INVENTORY or LIMITED_INVENTORY. Vertical sensitivity category ID. You can use /tool/content_exclusion/get/ to get a list of vertical categories containing sensitive content (vertical_sensitivity_list) that can be excluded from appearing next to your ads.OFF, ONE_DAY, or SEVEN_DAYS; allowed values vary by objective. Manual configuration requires both view_attribution_window and click_attribution_window; optional engaged_view_attribution_window also requires both. If all attribution-window fields and attribution_event_count are omitted, provider defaults may apply; inspect /adgroup/get/. Once set, this field cannot be updated.shopping_ads_type is VIDEO and product_source is CATALOG or STORE. Optional when shopping_ads_type is LIVE. Not supported when shopping_ads_type is PRODUCT_SHOPPING_ADS and product_source is STORE. ID of the Business Center that has permission for the catalog. For catalogs in Business Center, you must specify the ID of the Business Center that a catalog belongs to. Note: Starting June 30th, 2024, when product_source is STORE, you will no longer need to pass catalog_authorized_bc_id because it will be ignored.OFF, ONE_DAY, SEVEN_DAYS, FOURTEEN_DAYS, or TWENTY_EIGHT_DAYS; allowed values vary by objective. Manual configuration requires both click_attribution_window and view_attribution_window; engaged_view_attribution_window is optional but also requires both. If all attribution-window fields and attribution_event_count are omitted, provider defaults may apply; inspect /adgroup/get/. Once set, this field cannot be updated.deep_funnel_optimization_status is ON. The event source type. Enum values: PIXEL: Pixel. OFFLINE: Offline Event Set.CRM: CRM Event Set.messaging_app_type is MESSENGER or LINE.Ignored when messaging_app_type is WHATSAPP, ZALO, or IM_URL. The ID of the instant messaging app account. When messaging_app_type is MESSENGER, specify the Facebook Page ID via this field.To find your Facebook Page ID, go to your Facebook Page and click About below your cover photo, then click Page transparency.When messaging_app_type is LINE, specify the LINE Business ID via this field.To find your LINE Business ID, go to your LINE official account page.When messaging_app_type is WHATSAPP, this field will be ignored and be set as the corresponding WhatsApp phone number automatically populated based on the specified phone_region_code, phone_region_calling_code, and phone_number. Note: Once set, this field cannot be updated.identity_type is BC_AUTH_TT. ID of the Business Center that a TikTok Account User in Business Center identity is associated with.messaging_app_type is WHATSAPP or ZALO. The region calling code for the WhatsApp or Zalo phone number. Example: +1. To obtain the region code (phone_region_code) and region calling code (phone_region_calling_code) for the region that is associated with a specific phone number, use /tool/phone_region_code/. Note: Once set, this field cannot be updated.is_search_campaign is true. Whether to enable automated keywords and let the system automatically generate keywords after you add ads. This expands high-quality traffic to improve performance. View high-performing automated keywords in reporting. Supported values: true, false. Default value: false. Note: Automated keywords in Search Ads Campaigns are currently an allowlist-only feature. If you would like to access it, please contact your TikTok representative.deep_funnel_optimization_status is ON. Event Source ID. When deep_funnel_event_source is PIXEL, specify a Pixel ID via this field. To obtain a list of Pixels, use /pixel/list/.When deep_funnel_event_source is OFFLINE, specify an Offline Event Set ID via this field. To obtain a list of Offline Event Set IDs, use /offline/get/. When deep_funnel_event_source is CRM, specify a CRM Event Set ID via this field. To obtain a list of CRM Event Set IDs, use /crm/list/.optimization_goal=INSTALL or VALUE; see Secondary-goal events for valid values. When specified, also pass deep_bid_type. Since November 30, 2024, new/copied APP_PROMOTION ad groups cannot use INSTALL plus a secondary event on TikTok-only or automatic placement. Normal placement containing only PLACEMENT_PANGLE, PLACEMENT_GLOBAL_APP_BUNDLE, or both remains supported; existing TikTok ad groups are unaffected.shopping_ads_type is VIDEO and product_source is CATALOG. The retargeting type of shopping ads. Enum values: LAB1: Retargeting audiences who viewed products or added products to cart but didn’t purchase products. LAB2: Retargeting audiences who added products to cart but didn’t purchase products. LAB3: Retargeting audiences using custom combination. OFF: No retargeting.ON, OFF. Note: App Profile Page is not supported in a Dedicated Campaign with optimization goal as in-app event and bid strategy as cost cap. Therefore, you cannot set this field to ON when the following conditions are all met:ios14_targeting is set to IOS14_PLUS``optimization_goal is set to IN_APP_EVENT``bid_type is set to BID_TYPE_CUSTOMdeep_funnel_optimization_status is ON. Deep funnel optimization event. To find out the supported values for Standard Events available for Pixels, Offline Event Sets, and CRM Event Sets, see the “Event name for ad creation” column in Supported Pixel events. To find the list of optimization events for a Pixel, use /pixel/list/ and check the returned optimization_event. Example: SHOPPING.purchase_intention_keyword_ids and interest_keyword_ids at the same time. Otherwise, keyword conflict will occur.purchase_intention_keyword_ids only supports Auction ads with theobjective_type as APP_PROMOTION,WEB_CONVERSIONS,LEAD_GENERATION, TRAFFIC, or PRODUCT_SALES with product_source as CATALOG, and the placement setting should include TikTok (PLACEMENT_TIKTOK) or Pangle (PLACEMENT_PANGLE).promotion_type is LEAD_GENERATION. The status of deep funnel optimization. Deep funnel optimization optimizes both your upper funnel events and deeper funnel events. You can select a secondary event alongside the primary optimization event, which can help improve campaign effectiveness. Enum values: ON: To enable deep funnel optimization. OFF: To disable deep funnel optimization. Default value: OFF. To learn about how to configure deep funnel optimization for Lead Generation ads, see Lead Generation ad with optimization location as Instant Form and Lead Generation ad with optimization location as Website. Note: Deep funnel optimization with CRM events is currently an allowlist-only feature. If you would like to access it, please contact your TikTok representative. Deep funnel optimization with Pixel or Offline events is generally available.ONE_DAY or SEVEN_DAYS; allowed values vary by objective. If provided, also pass click_attribution_window and view_attribution_window. If all attribution-window fields and attribution_event_count are omitted, provider defaults may apply; inspect /adgroup/get/. Once set, this field cannot be updated.true, false. To learn more about Smart interests & behaviors and how to turn on Smart interests & behaviors, see Smart Targeting.included_pangle_audience_package_ids at the same time. IDs of the Pangle audiences that you want to exclude. You can get audience IDs (package_id) by using the /pangle_audience_package/get/ endpoint. The bind_type for the package should be EXCLUDE.excluded_pangle_audience_package_ids at the same time. IDs of the Pangle audiences that you want to include. You can get audience IDs (package_id) by using the /pangle_audience_package/get/ endpoint. The bind_type for the package should be INCLUDE.shopping_ads_retargeting_type is LAB1 or LAB2. The valid time range for the specified audience action. Audiences who have completed the specified action within the time range will be retargeted by the shopping ads. Value range: 1, 2, 3, 7, 14, 30, 60, 90, 180.audience_ids. Valid only with shopping_ads_type=VIDEO, product_source=CATALOG, shopping_ads_retargeting_type in LAB1, LAB2, or LAB3, and provided audience_ids. OR targets members of either audience; AND targets members of both. Omission also uses intersection (AND). Once set, it cannot be manually reset to null.Output
Create an R&F ad group
Create an R&F ad group
TIKTOK_ADS_CREATE_ADGROUP_RFCreate an R&F ad group. Availability may depend on TikTok allowlisting or account entitlement.Input Parameters
rf_purchased_type is FIXED_BUDGET. Use the value returned by the ad inventory estimate API.STANDARD_FEED, TOP_FEED. STANDARD_FEED refers to large inventory with normal CPM price while TOP_FEEDrefers to limited inventory with higher CPM price.frequency, together with frequency_schedule, controls how often people see your ad (only available for REACH ads). For example, frequency = 2 & frequency_schedule = 3 means “show ads no more than twice every 3 days”. The following conditions should be met:1 ≤ frequency ≤ frequency_schedule.1 ≤ frequency_schedule ≤ min (schedule_end_time - schedule_start_time, 30).The frequency cap determined by frequency and frequency_schedule does not exceed four times a day.AGE_13_17 cannot be used. For enum values, see Enumeration - Age Group. In certain scenarios, creation of ad groups that target the age group 13-17 (AGE_13_17) in the US will not be allowed. See New age restrictions for ads on TikTok to learn more. If you use targeting options that are not supported for the age group 13-17 in the US and leave the age_groups field unspecified or set it as [], an error will occur. You need to explicitly specify the exact age groups that you want to target, such as AGE_18_24, in the field to avoid any errors.request_id returned in the response parameters, which is used to uniquely identify an HTTP request. The value should be a string representation of a 64-bit integer number. Example: "123456789"in_use field for the carrier is true. The carriers must be consistent with the location(s) that you want to target. Use Get Carriers to get carrier IDs.audience_sub_type to REACH_FREQUENCY when creating or updating the audience. Note: You cannot use Lookalike Audience in R&F ads. Otherwise, an error will occur.STANDARD: even delivery; unavailable for View+ (optimization_goal=REACH, cpv_video_duration=SIX_SECONDS). SCHEDULE: delivery in specified periods and requires schedules. SEQUENCE: specified ad order and requires expected_orders. VIEW_OPTIMIZE: maximize view-through rate and available only for View+. OPTIMIZE: deprecated optimized delivery.unlimited. For enum values, see Enumeration - Connection Type.APP_ANDROID, APP_IOS, WEBSITE, WEBSITE_OR_DISPLAY. If objective_type is RF_REACH, set this field to WEBSITE_OR_DISPLAY.delivery_mode is set to SEQUENCE, the number of objects in this array represents the number of ads that you will specify the sequence for.False.rf_purchased_type is FIXED_REACH. Use the value returned by the ad inventory estimate API.device_price_ranges must not be specified. For enum values of device model IDs on different levels, please see Device Models. Note: Only active devices (is_active = True in the response of /tool/device_model/) can be used to create ads.NO_BRAND_SAFETY. NO_BRAND_SAFETY: full inventory, possibly beside mature themes. EXPANDED_INVENTORY: most inappropriate and mature content removed; replaces NO_BRAND_SAFETY as the next-version default. STANDARD_INVENTORY: content appropriate for most brands. LIMITED_INVENTORY: no mature themes. THIRD_PARTY: third-party filtering and requires brand_safety_partner; this option is allowlist-only. Use /tool/region/ for eligible regions.objective_type on the campaign level. Enum values: REACH, VIDEO_VIEW, CLICK, POST_ENGAGEMENT, INSTALL. Note:For TikTok Pulse ad groups where rf_campaign_type is set to PULSE in /campaign/create/ at the campaign level, if you want to use the 6s view-through rate (View+) optimization goal, set optimization_goal to REACH and cpv_video_duration to SIX_SECONDS.The 6s view-through rate (View+) optimization goal in TikTok Pulse ad groups is currently an allowlist-only feature. If you would like to access it, please contact your TikTok representative.FIXED_SHOW: Purchase to achieve a fixed amount of impressions.FIXED_REACH: Purchase to reach a fixed number of users.FIXED_BUDGET: Purchase with a fixed budget.YYYY-MM-DD HH:MM:SS. The time interval between schedule_start_time and schedule_end_time must not exceed 90 days. The value of this field must be at YYYY-MM-DD HH:59:59 for the time zone where the ad will be delivered. For instance, if an advertiser in the UTC-5 time zone wants to create an R&F ad group that ends delivery on November 10th, 2023, this field must be set to "2023-11-10 04:59:59".brand_safety_type=THIRD_PARTY or feed_type=TOP_FEED. rf_campaign_type=PULSE requires at least one PREMIUM tag. Max Pulse supports AE, AU, BR, CA, DE, ES, FR, GB, IT, MX, SA, TR, US; Category Lineups support US, CA, BR, AU, GB, FR, IT, ES, DE. Both are allowlist-only.optimization_goal is VIDEO_VIEW or when you want to use the 6s view-through rate (View+) optimization goal. The target video view duration. Enum value: SIX_SECONDS. Note: For TikTok Pulse campaigns where rf_campaign_type is set to PULSE in /campaign/create/ at the campaign level, if you want to use the 6s view-through rate (View+) optimization goal, set optimization_goal to REACH and cpv_video_duration to SIX_SECONDS.frequency_schedule, together with frequency, controls how often people see your ad (only available for REACH ads). See frequency field for more.YYYY-MM-DD HH:MM:SS. The time interval between schedule_start_time and schedule_end_time must not exceed 90 days. The value of this field must be at YYYY-MM-DD HH:00:00 for the time zone where the ad will be delivered. For instance, if an advertiser in the UTC-5 time zone wants to create an R&F ad group that starts delivery on November 1st, 2023, this field must be set to "2023-11-01 05:00:00".brand_safety_type is THIRD_PARTY. Enum values: IAS, OPEN_SLATE(The partner is named DoubleVerify on TikTok Ads Manager because the partner has been acquired by DoubleVerify). Note: Pre-bid third-party brand safety solutions are currently allowlist-only features. If you would like to access them, please contact your TikTok representative. Once set, this field cannot be modified.rf_purchased_type is FIXED_SHOW. Use the value returned by the ad inventory estimate API.audience_sub_type to REACH_FREQUENCY when creating or updating the audience. Note: You cannot use Lookalike Audience in R&F ads. Otherwise, an error will occur.brand_safety_type is set to STANDARD_INVENTORY or LIMITED_INVENTORY. Content exclusion category IDs. You can use /tool/content_exclusion/get/ to get a list of content category IDs (excluded_category_list) that can be excluded from being displayed next to your ads.false.Output
Create an app
Create an app
TIKTOK_ADS_CREATE_APPCreate a mobile app for an advertiser.Input Parameters
Output
Create a Business Center
Create a Business Center
TIKTOK_ADS_CREATE_BCCreate a persistent TikTok Business Center organization. This may establish a new administrative and billing boundary with no cleanup operation documented for this tool; obtain explicit approval immediately before execution and verify the name, company, registration area, currency, timezone, type, and contact data.Input Parameters
Output
Create an ad account
Create an ad account
TIKTOK_ADS_CREATE_BC_ADVERTISERCreate a persistent ad account in a Business Center, optionally configure its invoice grouping, Payment Portfolio linkage, and spending budget. Account creation can succeed even if portfolio binding or budget setup fails. Obtain explicit owner and finance approval immediately before execution; verify identity, region, currency, timezone, qualifications, tax data, payer, portfolio, and budget settings, then inspect both setup-result objects. Some options require TikTok allowlisting.Input Parameters
Output
Create a Billing Group
Create a Billing Group
TIKTOK_ADS_CREATE_BC_BILLING_GROUPCreate a persistent Billing Group and assign ad accounts to it. This changes invoice grouping and may make the group the Business Center default; obtain explicit approval immediately before execution and verify the Business Center, account IDs, immutable group type, email recipients, and is_primary setting.Input Parameters
Output
Create an asynchronous invoice download task
Create an asynchronous invoice download task
TIKTOK_ADS_CREATE_BC_INVOICE_TASKCreate a task that generates an invoice list, batch of invoice PDFs, or detailed billing report for later download. This exports finance-sensitive data and creates external task state; obtain explicit approval immediately before execution, verify the Business Center, invoice, output type, date range, payment filters, and campaign, and retrieve the result only to an approved storage destination.Input Parameters
Output
Create blocked words
Create blocked words
Create a blocked-word export task
Create a blocked-word export task
Create Business Center Asset Group
Create Business Center Asset Group
Create Business Center Organization Account
Create Business Center Organization Account
TIKTOK_ADS_CREATE_BUSINESS_CENTER_ORGANIZATION_ACCOUNTCreate an Organization Account in an authorized Business Center.Input Parameters
Output
Create Business Spark Ad
Create Business Spark Ad
TIKTOK_ADS_CREATE_BUSINESS_SPARK_ADCreate a campaign, ad group, and Spark Ad in one request. TikTok’s endpoint contract does not document their initial delivery status; the created resources may become eligible for delivery and spend, so verify their status after creation.Input Parameters
Output
Create a campaign
Create a campaign
TIKTOK_ADS_CREATE_CAMPAIGNCreate a Manual Campaign with documented campaign, objective, budget, RTA, and iOS settings.Input Parameters
Output
Create an asynchronous copy task for a Manual Campaign
Create an asynchronous copy task for a Manual Campaign
Create a catalog
Create a catalog
TIKTOK_ADS_CREATE_CATALOGCreate a catalog in a TikTok Business Center; some catalog types require allowlisting.Input Parameters
Output
Create a feed
Create a feed
TIKTOK_ADS_CREATE_CATALOG_FEEDCreate a scheduled catalog feed. INCREMENTAL preserves products omitted from the next import; OVERWRITE permanently removes omitted products, so confirm the complete source file before using it.Input Parameters
Output
Create Catalog Product Diagnostic Task
Create Catalog Product Diagnostic Task
TIKTOK_ADS_CREATE_CATALOG_PRODUCT_DIAGNOSTIC_TASKCreate an asynchronous download task for catalog product diagnostic information.Input Parameters
Output
Create Catalog Product Set by File
Create Catalog Product Set by File
Create a product set by conditions
Create a product set by conditions
Create Change Log Download Task
Create Change Log Download Task
TIKTOK_ADS_CREATE_CHANGELOG_TASKCreate an asynchronous download task for an advertiser’s change log.Input Parameters
Output
Create a comment export task
Create a comment export task
Create Creative Welcome Message
Create Creative Welcome Message
Create a portfolio
Create a portfolio
Create Creative Pre-Review Task
Create Creative Pre-Review Task
Create a CRM Event Set
Create a CRM Event Set
Create a Custom Conversion
Create a Custom Conversion
Create a Customer File Audience
Create a Customer File Audience
TIKTOK_ADS_CREATE_DMP_CUSTOM_AUDIENCECreate a custom audience from previously uploaded encrypted customer files.Input Parameters
Output
Create a Lookalike Audience
Create a Lookalike Audience
Create a Rule-Based Custom Audience
Create a Rule-Based Custom Audience
TIKTOK_ADS_CREATE_DMP_CUSTOM_AUDIENCE_RULECreate a custom audience from conditional inclusion and exclusion event rules.Input Parameters
Output
Create a Saved Audience
Create a Saved Audience
Create GMV Max Campaign
Create GMV Max Campaign
Create GMV Max Session
Create GMV Max Session
Create shop-level customized TikTok posts
Create shop-level customized TikTok posts
Create an Identity
Create an Identity
Create MMM Data Request
Create MMM Data Request
TIKTOK_ADS_CREATE_MMM_DATA_REQUESTCreate an irreversible Media Mix Modeling export job after explicit confirmation. Processing can take up to 24 hours, and the request cannot be cancelled through this tool once submitted.Input Parameters
Output
Create an Offline Event Set
Create an Offline Event Set
Create rules
Create rules
Create a test lead
Create a test lead
Create a lead download task
Create a lead download task
TIKTOK_ADS_CREATE_PAGE_LEAD_TASKCreate an asynchronous export task for leads from one Instant Form or ad. This is a lead export endpoint, not Events API ingestion; only ad-account or Business Center admins can use it.Input Parameters
Output
Create a Payment Portfolio
Create a Payment Portfolio
TIKTOK_ADS_CREATE_PAYMENT_PORTFOLIOCreate a SHARED Payment Portfolio and link ad accounts so they jointly use centrally managed funds. This creates persistent financial configuration; obtain explicit finance-owner approval immediately before execution and verify the name, every account ID, same-client eligibility, and administrator access.Input Parameters
Output
Create a Pixel
Create a Pixel
Create Pixel Events
Create Pixel Events
Create asynchronous report task
Create asynchronous report task
TIKTOK_ADS_CREATE_REPORT_TASKCreate an asynchronous TikTok report task and return its task ID; use the separate check and download tools to observe completion and retrieve output.Input Parameters
Output
Create Smart Creative Ads
Create Smart Creative Ads
TIKTOK_ADS_CREATE_SMART_CREATIVE_ADSCreate current Smart Creative ads in an ad group configured with creative_material_mode=SMART_CREATIVE. TikTok returns a mock processing result without ad IDs; wait 2-3 seconds and call GET_SMART_CREATIVE_MATERIALS to read final data. This is not the retired DYNAMIC ACO mode.Input Parameters
Output
Create Smart+ Ad
Create Smart+ Ad
Create Smart+ Ad Group
Create Smart+ Ad Group
TIKTOK_ADS_CREATE_SMART_PLUS_ADGROUPCreate a Smart+ ad group disabled for review in an existing Smart+ campaign. Use the separate Smart+ ad group status tool to enable it.Input Parameters
Output
Create Smart+ Campaign
Create Smart+ Campaign
TIKTOK_ADS_CREATE_SMART_PLUS_CAMPAIGNCreate a Smart+ campaign disabled for review. Use the separate Smart+ campaign status tool to enable it after review.Input Parameters
Output
Create Smart+ Campaign Copy Task
Create Smart+ Campaign Copy Task
TIKTOK_ADS_CREATE_SMART_PLUS_CAMPAIGN_COPY_TASKCreate and start an asynchronous copy task for an Upgraded Smart+ campaign. The copied campaign defaults to DISABLE, but copied ad groups and copied ads default to ENABLE. To keep all copied resources ineligible for delivery and spend, explicitly set operation_status to DISABLE on the campaign and on every copied ad group and ad; otherwise provider defaults may enable nested resources.Input Parameters
Output
Create a split test
Create a split test
Create Video Fix Tasks
Create Video Fix Tasks
Delete assets from a BC
Delete assets from a BC
Delete a member or revoke an invitation
Delete a member or revoke an invitation
Delete a partner from a BC
Delete a partner from a BC
Cancel the sharing of assets
Cancel the sharing of assets
Delete blocked words
Delete blocked words
Delete Business Center Asset Group
Delete Business Center Asset Group
TIKTOK_ADS_DELETE_BUSINESS_CENTER_ASSET_GROUPDelete one Asset Group from a TikTok Business Center. This destructive operation revokes members’ access to the grouped assets, but does not delete the underlying members or assets.Input Parameters
Output
Delete a catalog
Delete a catalog
Delete a feed
Delete a feed
Remove products
Remove products
Delete product sets
Delete product sets
Delete Catalog Video
Delete Catalog Video
Delete a comment
Delete a comment
Delete Creative Assets
Delete Creative Assets
Delete creative portfolios
Delete creative portfolios
TIKTOK_ADS_DELETE_CREATIVE_PORTFOLIOPermanently delete up to 100 eligible creative portfolios. Use only explicitly confirmed disposable targets; one invalid ID fails the batch.Input Parameters
Output
Delete a Custom Conversion
Delete a Custom Conversion
Delete Custom Audiences
Delete Custom Audiences
Delete Saved Audiences
Delete Saved Audiences
Delete GMV Max Session
Delete GMV Max Session
Delete Customized TikTok Posts
Delete Customized TikTok Posts
TIKTOK_ADS_DELETE_GMV_MAX_CUSTOMIZED_POSTSPermanently delete shop-level customized TikTok posts.Input Parameters
Output
Delete Customized Identity
Delete Customized Identity
Delete an Offline Event Set
Delete an Offline Event Set
Delete a test lead
Delete a test lead
Delete a Pixel Event
Delete a Pixel Event
Delete a playable asset
Delete a playable asset
Delete Search Ad Negative Keywords
Delete Search Ad Negative Keywords
Delete Smart+ Resources
Delete Smart+ Resources
Disable Business Center Advertiser
Disable Business Center Advertiser
Discover new keywords
Discover new keywords
Download an invoice synchronously
Download an invoice synchronously
TIKTOK_ADS_DOWNLOAD_BC_INVOICEDownload one Business Center invoice. The file contains finance-sensitive billing data; confirm the Business Center and invoice IDs, obtain authorization to access the invoice, and store or share the returned file only in an approved location.Input Parameters
Output
Download exported blocked words
Download exported blocked words
Download exported comments
Download exported comments
Download leads from a completed export task
Download leads from a completed export task
TIKTOK_ADS_DOWNLOAD_PAGE_LEAD_TASKDownload the CSV or ZIP produced by a completed TikTok lead export task. The file contains customer lead data, expires about 10 minutes after generation, and must be stored or shared only in an approved location.Input Parameters
Output
Get asynchronous report download
Get asynchronous report download
Download negative keywords
Download negative keywords
Edit an image
Edit an image
End a split test
End a split test
Estimate audience size
Estimate audience size
Get inventory estimates
Get inventory estimates
TIKTOK_ADS_ESTIMATE_RF_INVENTORYGet inventory estimates. Availability may depend on TikTok allowlisting or account entitlement.Input Parameters
rf_purchased_type = FIXED_BUDGET. Based on the budget amount that you specify, we will return the estimated values for other fields.STANDARD_FEED, TOP_FEED. STANDARD_FEED refers to large inventory with normal CPM price while TOP_FEEDrefers to limited inventory with higher CPM price.frequency_schedule parameter, determines the upper limit for how frequently an ad is shown to users (only for R&F ads). For example, if frequency = 2 and frequency_schedule = 3, it means the ad will be displayed at most twice every 3 days. The following conditions should be met:1 ≤ frequency ≤ frequency_schedule1 ≤ frequency_schedule ≤ min(schedule_end_time - schedule_start_time, 30). The frequency cap determined by frequency and frequency_schedule does not exceed four times a day.rf_purchased_type = FIXED_REACH. Based on the reach amount that you specify, we will return the estimated values for other fields.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. Enum values: STANDARD (Reach & Frequency campaign), PULSE (TikTok Pulse campaign). If you set this field as PULSE, only one location ID (location_id) will be returned. Note: Do not pass in this field when objective_type is not specified as RF_REACH.You need to pass the location_id value returned in this endpoint to location_ids when you use /adgroup/rf/create/ to create a TikTok Pulse ad group.FIXED_SHOW: Purchase to achieve a fixed amount of impressions.FIXED_REACH: Purchase to reach a fixed number of users.FIXED_BUDGET: Purchase with a fixed budget.schedule_end_time and schedule_start_time must not exceed 30 days. Note: If the targeting locations (location_ids) you specify observe Daylight Saving Time, ignore Daylight Saving Time and pass in Standard Time. For example, if you want to end the schedule for the Netherlands at 2022-11-02 23:59:59 local time (Daylight Saving Time has started, UTC+2 timezone) , you need to regard the time zone of the Netherlands as Standard Time Zone (UTC+1) and specify this field as 2022-11-02 22:59:59.SIX_SECONDS, TWO_SECONDS.frequency parameter, determines the upper limit for how frequently an ad is displayed to users (only for R&F ads). Please see the description for the frequency field.location_ids) you specify observe Daylight Saving Time, ignore Daylight Saving Time and pass in Standard Time. For example, if you want to start the schedule for the Netherlands at 2022-04-02 00:00:00 local time (Daylight Saving Time has started, UTC+2 timezone), you need to regard the time zone of the Netherlands as Standard Time Zone (UTC+1) and specify this field as 2022-04-02 23:00:00.rf_purchased_type = FIXED_SHOW. Based on the impression amount that you specify, we will return the estimated values for other fields.Output
Generate Smart Text recommendations
Generate Smart Text recommendations
Check the verification status of your account
Check the verification status of your account
Get available verification document types for a region
Get available verification document types for a region
Get Ad Benchmarks
Get Ad Benchmarks
TIKTOK_ADS_GET_AD_BENCHMARK_REPORTGet one page of ad benchmark dimensions and dynamic numeric metrics, scoped by exactly one ad_ids, adgroup_ids, or campaign_ids filter.Input Parameters
Output
Get additional interest categories by ID
Get additional interest categories by ID
Get diagnoses for ad groups
Get diagnoses for ad groups
Get the dynamic quota on active ad groups
Get the dynamic quota on active ad groups
Get review info of ad groups
Get review info of ad groups
Get estimated info of R&F ad groups
Get estimated info of R&F ad groups
Get review info of ads
Get review info of ads
Get Advertiser Accounts
Get Advertiser Accounts
TIKTOK_ADS_GET_ADVERTISER_ACCOUNTSGet advertiser account profiles for specified IDs, or discover authorized accounts using stored OAuth advertiser IDs or app credentials. Discovery requires one of those metadata sources and may return either profiles or account summaries.Input Parameters
Output
Get info of an app
Get info of an app
Get App Conversion Events
Get App Conversion Events
Get App Retargeting Events
Get App Retargeting Events
Get Asset Binding Quota
Get Asset Binding Quota
Get Details of Audience Overlap
Get Details of Audience Overlap
Get Audience Insights
Get Audience Insights
Get assets as admin
Get assets as admin
TIKTOK_ADS_GET_BC_ASSET_ADMINGet one page of assets administered by a Business Center.Input Parameters
Output
Get members by an asset
Get members by an asset
TIKTOK_ADS_GET_BC_ASSET_MEMBERGet one page of Business Center members assigned to an asset.Input Parameters
Output
Get the invoices of a Business Center
Get the invoices of a Business Center
TIKTOK_ADS_GET_BC_INVOICEReturn one page of Business Center invoices using type, payment, title, ID, and issuance-time filters. TikTok makes these invoices available to the Business Center’s Finance Managers and Finance Analysts; results may contain sensitive invoice, tax, address, and balance data.Input Parameters
Output
Get an asynchronous invoice download task
Get an asynchronous invoice download task
Get the unpaid amount of a Business Center
Get the unpaid amount of a Business Center
Get the assets of a partner
Get the assets of a partner
TIKTOK_ADS_GET_BC_PARTNER_ASSETGet one page of assets shared with or by a partner Business Center.Input Parameters
Output
Get Bid Protection Details
Get Bid Protection Details
TIKTOK_ADS_GET_BID_PROTECTION_DETAILSGet bid protection history and ad credits for specified Upgraded Smart+ campaigns or ad groups over a date range. The start date must be within the past 60 days, and the number of IDs accepted depends on the date range.Input Parameters
Output
Get Bid Protection Statuses
Get Bid Protection Statuses
Get Business Center Advertiser Attributes
Get Business Center Advertiser Attributes
Get Business Center Asset Group
Get Business Center Asset Group
TIKTOK_ADS_GET_BUSINESS_CENTER_ASSET_GROUPGet the assets or members of an Asset Group in a Business Center.Input Parameters
Output
Get Business Center Balance
Get Business Center Balance
TIKTOK_ADS_GET_BUSINESS_CENTER_BALANCERead the balance of a TikTok Business Center or Payment Portfolio. This action only retrieves financial information and never funds an account.Input Parameters
Output
Get Campaign Quota Information
Get Campaign Quota Information
Get available regions
Get available regions
Get Catalog Category Insights
Get Catalog Category Insights
Get event source binding info of a catalog
Get event source binding info of a catalog
Get feeds
Get feeds
Get the log of a feed
Get the log of a feed
Get Catalog Insight Filters
Get Catalog Insight Filters
TIKTOK_ADS_GET_CATALOG_INSIGHT_FILTERSGet one page of provider-approved category, brand, or availability filter values for product insight endpoints. TikTok returns no pagination metadata, so choose page and page_size explicitly when requesting additional pages.Input Parameters
Output
Get the lexicon list for a catalog
Get the lexicon list for a catalog
Get locations and currencies
Get locations and currencies
Get the overview of a catalog
Get the overview of a catalog
Get products
Get products
Get Catalog Product Diagnostic Task
Get Catalog Product Diagnostic Task
Get the product handling log
Get the product handling log
Get product sets
Get product sets
Get products in a product set
Get products in a product set
Get the catalog video handling log
Get the catalog video handling log
Get video packages
Get video packages
Get details of content exclusion categories
Get details of content exclusion categories
Get Creative Assets
Get Creative Assets
Get a portfolio by ID
Get a portfolio by ID
Get Creative Pre-Review Task
Get Creative Pre-Review Task
Get creative report
Get creative report
Get the message event sets for ad creation
Get the message event sets for ad creation
Get Custom Audience Details
Get Custom Audience Details
Get Custom Audience Sharing Log
Get Custom Audience Sharing Log
Get the details of a Custom Conversion
Get the details of a Custom Conversion
Get catalog event source diagnostic information
Get catalog event source diagnostic information
Get catalog event trends and match rate
Get catalog event trends and match rate
Get the Application Log of Audiences
Get the Application Log of Audiences
Get the music list
Get the music list
TIKTOK_ADS_GET_FILE_MUSICGet one page of advertiser music and return a continuation cursor.Input Parameters
Output
Get suggested thumbnails for a video
Get suggested thumbnails for a video
Get GMV Max Bid Recommendation
Get GMV Max Bid Recommendation
Get GMV Max Campaigns
Get GMV Max Campaigns
Get GMV Max Campaign Info
Get GMV Max Campaign Info
Get GMV Max Sessions
Get GMV Max Sessions
TIKTOK_ADS_GET_GMV_MAX_CAMPAIGN_SESSIONSGet max delivery or creative boost session details by 1 to 20 exact session IDs. This is an ID lookup, not the active-session campaign listing; use LIST_GMV_MAX_CAMPAIGN_SESSIONS to list active sessions for one Product GMV Max campaign.Input Parameters
Output
Get GMV Max Report
Get GMV Max Report
TIKTOK_ADS_GET_GMV_MAX_REPORTRun one paginated Product or LIVE GMV Max campaign report.Input Parameters
Output
Get product linkage details of videos in customized posts
Get product linkage details of videos in customized posts
Get the Identity List
Get the Identity List
TIKTOK_ADS_GET_IDENTITY_GETReturn one page of advertiser identities. Creator-account capabilities and availability are authorization gates: inspect can_pull_video, can_push_video, ads_only_mode, is_gpppa, and available_status before using an identity for posts or Spark Ads.Input Parameters
Output
Get Info About an Identity
Get Info About an Identity
Get Live Videos Under an Identity
Get Live Videos Under an Identity
List Available TikTok Series
List Available TikTok Series
Get Posts Under an Identity
Get Posts Under an Identity
TIKTOK_ADS_GET_IDENTITY_VIDEO_GETReturn one page of posts visible through an authorized identity. AUTH_CODE exposes only creator-authorized posts; TT_USER and BC_AUTH_TT access depends on the account’s can_pull_video capability, privacy status, and Business Center authorization.Input Parameters
Output
Get Info About TikTok Posts
Get Info About TikTok Posts
TIKTOK_ADS_GET_IDENTITY_VIDEO_INFOGet one or up to 20 posts associated with an authorized identity. Private/friends-only visibility and expired AUTH_CODE authorization can limit returned media; BC_AUTH_TT requires its authorizing Business Center ID.Input Parameters
Output
Get an Instant Form or Direct-Message Lead
Get an Instant Form or Direct-Message Lead
TIKTOK_ADS_GET_LEADRetrieve lead answers and attribution metadata. The response can contain names, contact details, and other personal data supplied through form or direct-message questions; call only for an authorized advertiser or Business Center library, minimize retention, and do not disclose or reuse it outside the consented lead-processing purpose.Input Parameters
Output
Get Lead Fields
Get Lead Fields
TIKTOK_ADS_GET_LEAD_FIELDRetrieve only the field names and form metadata for Instant Form or direct-message leads. Lead schemas can reveal what personal data is collected; use only for an authorized advertiser or Business Center library and do not expose the result beyond the intended lead-processing purpose.Input Parameters
Output
Get the TikTok Minis within an ad account
Get the TikTok Minis within an ad account
Get MMM Download URL
Get MMM Download URL
Get MMM Request History
Get MMM Request History
Get Offline Event Sets
Get Offline Event Sets
Get rules by ID
Get rules by ID
Get result details
Get result details
Get Instant Pages
Get Instant Pages
Get the fields of an Instant Form
Get the fields of an Instant Form
Get a test lead
Get a test lead
Get form libraries
Get form libraries
Get the Pangle Block List
Get the Pangle Block List
Get Payment Portfolios
Get Payment Portfolios
TIKTOK_ADS_GET_PAYMENT_PORTFOLIOReturn one page of Payment Portfolios, cash balances, and credit line usage. This exposes highly sensitive financial capacity and account relationships; confirm the Business Center and filters and disclose results only to authorized finance administrators.Input Parameters
Output
Get ad accounts linked to a Payment Portfolio
Get ad accounts linked to a Payment Portfolio
Get Pixel Event statistics
Get Pixel Event statistics
Get Instant Page events
Get Instant Page events
Get playable assets
Get playable assets
Get recommended CTAs
Get recommended CTAs
Run synchronous integrated report
Run synchronous integrated report
Get R&F time zones
Get R&F time zones
Get Search Ads Campaign Health diagnoses
Get Search Ads Campaign Health diagnoses
Get available locations by advertiser ID
Get available locations by advertiser ID
Get Showcase Identity
Get Showcase Identity
Get Smart Creative Materials
Get Smart Creative Materials
Get Smart+ Material Report
Get Smart+ Material Report
TIKTOK_ADS_GET_SMART_PLUS_MATERIAL_REPORTGet one page of Smart+ material overview or breakdown reporting.Input Parameters
Output
Get Smart+ Review Info
Get Smart+ Review Info
Get the results of a split test
Get the results of a split test
Get products within a TikTok Shop
Get products within a TikTok Shop
Get subscription details of a developer app
Get subscription details of a developer app
TIKTOK_ADS_GET_SUBSCRIPTIONReturn one page of webhook subscriptions configured for a developer application.Input Parameters
Output
Get targeting information
Get targeting information
TIKTOK_ADS_GET_TARGETING_TAG_DETAILSGet geographical or ISP targeting tag details by targeting ID.Input Parameters
Output
Get Terms
Get Terms
Get the Brand Safety Hub settings of an ad account
Get the Brand Safety Hub settings of an ad account
Get Info About a Spark Ad Post
Get Info About a Spark Ad Post
TIKTOK_ADS_GET_TT_VIDEOResolve a creator-issued Spark post authorization code into post, creator, media, and authorization-window details. Possessing advertiser OAuth does not authorize the creator’s post; the creator must issue the code, and expired or restricted posts may not be usable.Input Parameters
Output
Get authenticated user info
Get authenticated user info
Get Video Fix Task
Get Video Fix Task
Get In-Second Video Performance
Get In-Second Video Performance
TIKTOK_ADS_GET_VIDEO_PERFORMANCE_REPORTGet one page of in-second AD or VIDEO performance. VIDEO mode supports either lifetime data or a bounded start_time/end_time window and returns dynamic metric arrays with ad_id, video_id, and duration info.Input Parameters
Output
Invite members to a BC
Invite members to a BC
List Ad Groups
List Ad Groups
TIKTOK_ADS_LIST_AD_GROUPSList regular or mixed-automation ad group inventory through TikTok’s generic /adgroup/get/ endpoint. This reader can filter MANUAL, SMART_PLUS, or UPGRADED_SMART_PLUS campaigns; use LIST_SMART_PLUS_ADGROUPS when the request specifically requires TikTok’s dedicated Smart+ ad group endpoint.Input Parameters
Output
List Ads
List Ads
TIKTOK_ADS_LIST_ADSList regular or mixed-automation ad inventory through TikTok’s generic /ad/get/ endpoint. This reader can filter MANUAL, SMART_PLUS, or UPGRADED_SMART_PLUS campaigns; use LIST_SMART_PLUS_ADS when the request specifically requires TikTok’s dedicated Smart+ ad endpoint.Input Parameters
Output
Get Advertiser Balance
Get Advertiser Balance
TIKTOK_ADS_LIST_ADVERTISER_BALANCESGet one page of ad account balances and budgets for a TikTok Business Center, with optional account filters and detailed balance fields.Input Parameters
Output
List Advertiser Budget Changes
List Advertiser Budget Changes
List Advertiser Qualifications
List Advertiser Qualifications
Get time zones
Get time zones
List Advertiser Transactions
List Advertiser Transactions
TIKTOK_ADS_LIST_ADVERTISER_TRANSACTIONSList one page of advertiser billing transactions accessible through a Business Center, with fund type, account, and UTC date filters. Transaction type defaults to transfers and can be changed.Input Parameters
Output
Get the app list
Get the app list
Get available attribution sources and data sources for an app
Get available attribution sources and data sources for an app
Get the advertiser list of a Billing Group
Get the advertiser list of a Billing Group
Get asynchronous invoice download task list
Get asynchronous invoice download task list
TIKTOK_ADS_LIST_BC_INVOICE_TASKReturn one page of asynchronous Business Center invoice list or invoice batch download tasks, including available download URLs. These references expose finance-sensitive billing files; confirm the Business Center and share or download them only to approved destinations.Input Parameters
Output
Get blocked words
Get blocked words
List Business Center Account Costs
List Business Center Account Costs
List Business Center Account Transactions
List Business Center Account Transactions
TIKTOK_ADS_LIST_BUSINESS_CENTER_ACCOUNT_TRANSACTIONSGet one page of itemized billing transactions for a Business Center, its ad accounts, or a Payment Portfolio, including invoice, tax, billing-type, and account details.Input Parameters
Output
Get Business Center Activity Log
Get Business Center Activity Log
TIKTOK_ADS_LIST_BUSINESS_CENTER_ACTIVITY_LOG_ENTRIESGet one page of activity-log records for a Business Center.Input Parameters
Output
List Business Center Advertisers
List Business Center Advertisers
List Business Center Asset Groups
List Business Center Asset Groups
List Business Center Asset Partners
List Business Center Asset Partners
TIKTOK_ADS_LIST_BUSINESS_CENTER_ASSET_PARTNERSGet one page of Business Center partners associated with an asset.Input Parameters
Output
List Business Center Billing Groups
List Business Center Billing Groups
TIKTOK_ADS_LIST_BUSINESS_CENTER_BILLING_GROUPSGet one page of billing groups in a TikTok Business Center.Input Parameters
Output
List Business Center Members
List Business Center Members
TIKTOK_ADS_LIST_BUSINESS_CENTER_MEMBERSGet one page of members in a TikTok Business Center.Input Parameters
Output
List Business Center Partners
List Business Center Partners
List Business Center Pixel Links
List Business Center Pixel Links
List Business Centers
List Business Centers
TIKTOK_ADS_LIST_BUSINESS_CENTERSList one page of Business Centers accessible to the connected TikTok authorization, optionally restricted to one Business Center ID.Input Parameters
Output
List Business Center Transactions
List Business Center Transactions
TIKTOK_ADS_LIST_BUSINESS_CENTER_TRANSACTIONSGet one page of Business Center-level cash or grant fund movements, with aggregate charged and paid amounts. Use account transactions instead for itemized ad-account, Payment Portfolio, invoice, tax, or billing details.Input Parameters
Output
List Campaign Labels
List Campaign Labels
List Campaigns
List Campaigns
TIKTOK_ADS_LIST_CAMPAIGNSList regular or mixed-automation campaign inventory through TikTok’s generic /campaign/get/ endpoint. This reader can filter MANUAL, SMART_PLUS, or UPGRADED_SMART_PLUS campaigns; use LIST_SMART_PLUS_CAMPAIGNS when the request specifically requires TikTok’s dedicated Smart+ campaign endpoint.Input Parameters
Output
Get Catalog Diagnostics
Get Catalog Diagnostics
TIKTOK_ADS_LIST_CATALOG_PRODUCT_DIAGNOSTICSGet one page of synchronous catalog product diagnostic information.Input Parameters
Output
List Catalogs
List Catalogs
Get Catalog Videos
Get Catalog Videos
Get comments
Get comments
Get available content exclusion categories
Get available content exclusion categories
Get Creative Welcome Messages
Get Creative Welcome Messages
Get Creative Fatigue Results
Get Creative Fatigue Results
List Creative Portfolios
List Creative Portfolios
Get CRM Event Sets
Get CRM Event Sets
List Custom Audiences
List Custom Audiences
TIKTOK_ADS_LIST_CUSTOM_AUDIENCESList one page of owned and shared custom audiences for an authorized advertiser, optionally restricted to specified audience IDs.Input Parameters
Output
Get Custom Conversions associated with an event source
Get Custom Conversions associated with an event source
Get Details of Saved Audiences
Get Details of Saved Audiences
List GMV Max Campaign Sessions
List GMV Max Campaign Sessions
TIKTOK_ADS_LIST_GMV_MAX_CAMPAIGN_SESSIONSList active max delivery or creative boost sessions for one Product GMV Max campaign ID. This is the campaign-scoped active-session listing; use GET_GMV_MAX_CAMPAIGN_SESSIONS to retrieve specific sessions by session IDs.Input Parameters
Output
List GMV Max Customized Posts
List GMV Max Customized Posts
TIKTOK_ADS_LIST_GMV_MAX_CUSTOMIZED_POSTSList one page of shop-level customized TikTok posts for GMV Max.Input Parameters
Output
List GMV Max Identities
List GMV Max Identities
Check GMV Max Occupied Custom Shop Ads
Check GMV Max Occupied Custom Shop Ads
TIKTOK_ADS_LIST_GMV_MAX_OCCUPYING_ADSCheck which Shopping Ads occupy one TikTok Shop identity or product asset.Input Parameters
Output
List TikTok Shops for GMV Max
List TikTok Shops for GMV Max
List GMV Max Videos
List GMV Max Videos
TIKTOK_ADS_LIST_GMV_MAX_VIDEOSList one page of authorized or custom-post-eligible TikTok posts for a Product GMV Max campaign.Input Parameters
Output
Get rules by filters
Get rules by filters
Get rule results
Get rule results
List Pangle Audience Packages
List Pangle Audience Packages
Get phone region codes
Get phone region codes
Get Pixels
Get Pixels
Get Recommended Search Keywords
Get Recommended Search Keywords
List Search Ad Negative Keywords
List Search Ad Negative Keywords
Get Showcase Products
Get Showcase Products
Get Showcase Regions
Get Showcase Regions
Get Smart+ Ad Groups
Get Smart+ Ad Groups
TIKTOK_ADS_LIST_SMART_PLUS_ADGROUPSList Smart+ ad group details through TikTok’s dedicated /smart_plus/adgroup/get/ endpoint. Select this instead of LIST_AD_GROUPS for an exact Smart+ endpoint read; use LIST_AD_GROUPS for regular or mixed-automation inventory.Input Parameters
Output
Get Smart+ Ads
Get Smart+ Ads
TIKTOK_ADS_LIST_SMART_PLUS_ADSList Upgraded Smart+ ad details for an advertiser through TikTok’s dedicated Smart+ endpoint, with optional filters and pagination. Returned creative lists include only explicitly selected creatives, not automatically added creatives.Input Parameters
Output
Get Smart+ Campaigns
Get Smart+ Campaigns
TIKTOK_ADS_LIST_SMART_PLUS_CAMPAIGNSList Smart+ campaign details through TikTok’s dedicated /smart_plus/campaign/get/ endpoint. Select this instead of LIST_CAMPAIGNS for an exact Smart+ endpoint read; use LIST_CAMPAIGNS for regular or mixed-automation inventory.Input Parameters
Output
Get available stores under an ad account
Get available stores under an ad account
Get carriers
Get carriers
Get device models
Get device models
Get internet service providers
Get internet service providers
Get languages
Get languages
Get OS versions
Get OS versions
Get targeting regions
Get targeting regions
TIKTOK_ADS_LIST_TARGETABLE_REGIONSGet locations available for an advertiser’s placement, objective, and campaign settings.Input Parameters
Output
Get action categories
Get action categories
Get interest categories
Get interest categories
TIKTOK_ADS_LIST_TARGETING_INTEREST_CATEGORIESGet advertiser interest categories, optionally filtered by placement and special industry.Input Parameters
Output
List Ad Accounts Linked to TikTok Account
List Ad Accounts Linked to TikTok Account
TIKTOK_ADS_LIST_TIKTOK_LINKED_AD_ACCOUNTSList one page of ad accounts linked to one TikTok account asset in a Business Center.Input Parameters
Output
Get Trending Catalog Products
Get Trending Catalog Products
List Trending Videos for Commercial Music
List Trending Videos for Commercial Music
List Trending Commercial Music
List Trending Commercial Music
TIKTOK_ADS_LIST_TRENDING_COMMERCIAL_MUSICList trending tracks from TikTok’s Commercial Music Library for a TikTok Business Account. Select a genre, country, and popularity timeframe to explore regional music trends.Input Parameters
Output
Get Trending Search Keywords
Get Trending Search Keywords
Get Spark Ad Posts
Get Spark Ad Posts
Migrate a catalog to a BC
Migrate a catalog to a BC
Run the winning ad group
Run the winning ad group
Query contracts
Query contracts
TIKTOK_ADS_QUERY_RF_CONTRACTRead whether an advertiser has a valid Reach & Frequency or TikTok Pulse contract for a specified date. This operation does not create, update, or otherwise mutate contracts or financial settings. Availability may depend on TikTok allowlisting or account entitlement.Input Parameters
STANDARD (Reach & Frequency), PULSE(TikTok Pulse). Note: This is an allowlist-only feature. If you would like to access it, please contact your TikTok representative.Output
Get a suggested bid
Get a suggested bid
TIKTOK_ADS_RECOMMEND_BIDGet a suggested bid for an objective and target locations.Input Parameters
Output
Recommend additional interest categories
Recommend additional interest categories
Get recommended search keywords
Get recommended search keywords
Recommend targeting categories
Recommend targeting categories
Save a playable asset
Save a playable asset
Search for images
Search for images
Search for videos
Search for videos
Search or list interest and behavior targeting
Search or list interest and behavior targeting
Create or Delete an Audience Segment
Create or Delete an Audience Segment
Set Search Ad Negative Keywords
Set Search Ad Negative Keywords
TIKTOK_ADS_SET_SEARCH_AD_NEGATIVE_KEYWORDSSet negative keywords on Search Ads campaigns or ad groups. By default, add the supplied keywords while preserving existing values. With replace=true, replace each object’s entire existing negative-keyword set and remove any existing values that are not supplied.Input Parameters
Output
Set Smart+ Delivery Status
Set Smart+ Delivery Status
Submit a verification request for your account
Submit a verification request for your account
Submit Smart Text feedback
Submit Smart Text feedback
TIKTOK_ADS_SUBMIT_CREATIVE_SMART_TEXTSubmit feedback parameters for an existing Smart Text recommendation flow. This feedback operation does not generate text; use GENERATE_CREATIVE_SMART_TEXT to create recommendations.Input Parameters
Output
Submit UnionPay Verification
Submit UnionPay Verification
TIKTOK_ADS_SUBMIT_UNIONPAY_VERIFICATIONSubmit identity and UnionPay account details to verify an eligible business license. This starts a sensitive review with no documented rollback.Input Parameters
Output
Create a subscription
Create a subscription
TIKTOK_ADS_SUBSCRIBE_SUBSCRIPTIONCreate a webhook subscription for a developer application and external callback URL.Input Parameters
Output
Process a payment
Process a payment
TIKTOK_ADS_TRANSFER_BCIrreversibly recharge or deduct cash, vouchers, or credit for an ad account or Business Center. This moves real financial value and cannot be assumed reversible. Require explicit finance-owner confirmation immediately before execution; verify the level, payer and payee IDs, portfolio, RECHARGE versus REFUND direction, currency context, every amount, minimum transfer limits, and a fresh idempotency request ID. Never retry with a different request ID after an uncertain result. Some behavior is allowlist-only.Input Parameters
RECHARGE adds funds or credit; REFUND deducts funds or credit.Output
Transfer a pixel from advertiser to BC
Transfer a pixel from advertiser to BC
Migrate leads to a Business Center
Migrate leads to a Business Center
Unassign an asset
Unassign an asset
Unassign TikTok Account From Advertiser
Unassign TikTok Account From Advertiser
TIKTOK_ADS_UNASSIGN_TIKTOK_ACCOUNT_FROM_ADVERTISERUnlink a TikTok account from an ad account in the same Business Center. This destructively removes the existing account association.Input Parameters
Output
Unbind an event source from a catalog
Unbind an event source from a catalog
Unbind a Spark Ad Post
Unbind a Spark Ad Post
Cancel a subscription
Cancel a subscription
Update ads
Update ads
TIKTOK_ADS_UPDATE_ADUpdate ordinary ads and their creative fields in an ad group. Updates default the AI-generated-content disclosure to NOT_DECLARED; most standard creatives also require media, ad text and a call to action, or a TikTok post ID, even for patch-style updates.Input Parameters
Output
Update an ad group
Update an ad group
TIKTOK_ADS_UPDATE_ADGROUPUpdate an ad group, including irreversible changes to its HFSS setting. Availability may depend on TikTok allowlisting or account entitlement.Input Parameters
budget_optimize_on) is on. For how to configure budget settings, see Budget. To directly see the daily budget value range for a currency, see Currency-Daily budget value range. Note: The new budget should be at least 105% of the current spend. You can run a synchronous report or an asynchronous report to get the spend data via the Basic data metric spend .PACING_MODE_SMOOTH and PACING_MODE_FAST. For PACING_MODE_SMOOTH, the budget is allocated evenly within the scheduled time. PACING_MODE_FAST would consume budget and produce results as soon as possible. When Campaign Budget Optimization (budget_optimize_on) is on, your setting will be ignored and it will be set as PACING_MODE_SMOOTH. Otherwise, this field is required.true. In regulated regions, HFSS ads must only be targeted to users aged 18 or over. You can set this field to true when your targeting locations include locations in the UK, Australia, New Zealand, and the European Union. Supported values: true,false. Note: You can only update this setting from false to true but not vice versa.location_ids at the same time. You can use /tool/targeting/list/ to get the ISP IDs that you can target for a location ID. Note: When you pass in isp_ids, you cannot set the placement as Global App Bundle only (placements =PLACEMENT_GLOBAL_APP_BUNDLE).budget_optimize_on = TRUE).deep_bid_type is VO_MIN_ROAS. ROAS goal for Value Optimization. Value range: For in-app advertising scenarios (objective_type is APP_PROMOTION, optimization_goal is VALUE, and optimization_event is AD_REVENUE_VALUE): 0.01-10.For Product Shopping Ads with product source as TikTok Shop (shopping_ads_type is PRODUCT_SHOPPING_ADS and product_source is STORE): 0.01-20.For other scenarios: 0.01-1,000.bid_type is BID_TYPE_CUSTOM and billing_event is CPC, CPM, or CPV. Bid price. The average cost per result that you want to achieve (for Cost Cap bidding strategy). When Campaign Budget Optimization (budget_optimize_on) is on, we suggest that you set the same bid value for all ad groups in the campaign. bid_price needs to be lower than budget set at the campaign level and ad group level. See Bidding-Bidding limits to learn more about the bid verification mechanism.frequency_schedule, controls how often people see your ad (only available for REACH ads). The below conditions should be both met:1 1 For example, frequency = 2 & frequency_schedule = 3 means “show ads no more than twice every 3 day”.AGE_13_17) in the US, Latin America, the European Economic Area, the UK, Switzerland, or Canada will not be allowed. See New age restrictions for ads on TikTok to learn more.If you are impacted by the restrictions and leave the age_groups field unspecified or set it as [] without setting exclude_age_under_eighteen to true, an error will occur. If the ad group targets the age group 13-17 (AGE_13_17) in the US, Latin America, the European Economic Area, the UK, Switzerland, or Canada and you typically leave the age_groups field unspecified or set it as [], we recommend that you set exclude_age_under_eighteen to true simultaneously to avoid any errors.in_use field for the carrier is true. The carriers must be consistent with the location(s) that you want to target. See Get Carriers for detailed information.location_ids, zipcode_ids, or both; combined count <=3,000. Get IDs as geo_id with geo_type=ZIP_CODE from /tool/targeting/search/. ZIP codes support the US; postal codes support Canada, Brazil, Indonesia, Thailand, Vietnam, with the latter four allowlist-only. Not supported with special_industries or objective_type=RF_REACH; placements must include PLACEMENT_TIKTOK. Locations cannot overlap. After initially targeting the US, updates cannot remove all US locations and leave only non-US countries. To clear these IDs, pass []; because targeting is mandatory, also provide location_ids if these were the only locations.location_ids, zipcode_ids, or both; their combined location/zip/postal ID count cannot exceed 3,000. Locations cannot overlap (for example, US and California). After initially targeting the US, updates may change to other US locations but cannot remove all US locations and leave only non-US countries. If tiktok_subplacements contains TIKTOK_LITE, Japan and South Korea cannot both be removed. To clear location IDs, pass []; because targeting is mandatory, also provide zipcode_ids if these were the only locations.TRAFFIC or APP_PROMOTION. For details, see Audience Rules.app_promotion_type is APP_RETARGETING at the campaign level. Not supported when app_promotion_type is not set to APP_RETARGETING at the campaign level. App retargeting audience type. You need to use the same settings as when creating the ad group. Enum value:NEW_CUSTOM_AUDIENCE (retargeting custom audience). If you want to specify an empty retargeting custom audience for your App Retargeting ads, do not pass audience_ids and excluded_audience_ids. If you want to specify a non-empty retargeting custom audience for your App Retargeting ads, you can specify an Include Audience via audience_ids, or an Exclude Audience via excluded_audience_ids , or both simultaneously. If both audience_ids and excluded_audience_ids are specified, they cannot contain the same IDs.secondary_optimization_event is specified, you need to pass in deep_bid_type at the same time.SCHEDULE_START_END or SCHEDULE_FROM_NOW. If you choose SCHEDULE_START_END, you need to specify a start time and an end time. If you choose SCHEDULE_FROM_NOW, you only need to specify a start time and the end time will be automatically set to 10 years later than the start time.Trueis valid when the conditions below are all met:objective_type at the campaign level is set as one of the following objectives: APP_PROMOTION, WEB_CONVERSIONS, REACH, TRAFFIC, VIDEO_VIEWS, ENGAGEMENT, LEAD_GENERATION. Placement: placement_type= PLACEMENT_TYPE_AUTOMATIC orplacement_type= PLACEMENT_TYPE_NORMAL, and placements = PLACEMENT_TIKTOK Note: This field supports incremental updates.ALL, HIGH. If it is set to HIGH, you can target high spending users who typically spend more on purchases on TikTok ads than average users. Note: :This field does not support the advertising objectives PRODUCT_SALES and RF_REACH at the campaign level. See Advertising objectives for details. This field supports Automatic Placement and Select Placement with TikTok included. Therefore, you need to set placement_type to PLACEMENT_TYPE_AUTOMATIC, or include PLACEMENT_TIKTOK in the value of placements. Note that if you specify Pangle as a placement, the spending power targeting won’t take effect on Pangle. When auto_targeting_enabled is true at the ad group level, then spending_power will be automatically set to ALL.UNSET targets iOS 14.4 or earlier; IOS14_MINUS targets before 14.0; IOS14_PLUS targets 14.5+ in Dedicated Campaigns; ALL targets 14.5+ only for iOS App Retargeting or catalog Video Shopping retargeting optimized to app. campaign_type=IOS14_CAMPAIGN requires IOS14_PLUS and allows at most two active ad groups. For IOS14_PLUS, use an iOS app_id, operating_systems=["IOS"], compatible min_ios_version, and optimization_goal in CLICK, INSTALL, IN_APP_EVENT, VALUE; omit min_android_version, shopping_ads_retargeting_type, and shopping_ads_retargeting_actions_days, and do not use ad-level deeplink_type=DEFERRED_DEEPLINK. Once IOS14_PLUS, it cannot change. App Retargeting 14.5+ requires ALL and min_ios_version>=14.5; omit this field for 14.4 or earlier. ALL is forced for iOS App Retargeting (APP_RETARGETING + APP_IOS) and iOS catalog Video Shopping app retargeting (VIDEO, CATALOG, APP_IOS, retargeting not OFF). Otherwise defaults to UNSET.ios14_targeting is specified. Minimum iOS version. For enum values, see Enumeration - Minimum iOS Version.is_search_campaign returned for the campaign. To learn more about Search Ads Campaigns, see Create Search Ads Campaigns. Note: For each ad group, you can configure a maximum of 1,000 search keywords.Once the search keywords or the targeted locations are updated, the keywords will go into the review process again.deep_funnel_event_source, deep_funnel_event_source_id, and deep_funnel_optimization_event.is_active = True in the response of /tool/device_model/) can be used to create ads. Note: Device model (device_model_ids) and device price (device_price_ranges) cannot be set at the same time.TOP5(Top 5% of ZIP codes), TOP10(Top 10% of ZIP codes), TOP10_25(Top 10% -25% of ZIP codes), TOP25_50(Top 25% - 50% of ZIP codes). Currently, this field has the following limitations: Not supported in Reach&Frequency type ads.Only works on TikTok Placement in the US.EXPANDED_INVENTORY: most inappropriate and mature content removed; replaces NO_BRAND_SAFETY as the next-version default. STANDARD_INVENTORY: content appropriate for most brands. LIMITED_INVENTORY: no mature themes. Use /tool/region/ for eligible regions. Updating brand_safety_type, category_exclusion_ids, or vertical_sensitivity_id is allowlist-only and subject to pre-bid brand-safety update eligibility. First-party filtering for Auction APP_PROMOTION, WEB_CONVERSIONS, TRAFFIC, LEAD_GENERATION, and PRODUCT_SALES is also allowlist-only.is_lhf_compliance to true, you confirm that any food or drink products you advertise on TikTok in the UK comply with the 2024 Less Healthy Foods Regulations and all other applicable laws. Supported values: true,false. Note: Starting January 1st, 2026, when your ad targets locations in the UK and is_hfss is true, is_lhf_compliance is required and must be set to true.ANDROID, IOS. This field is required in two scenarios: objective_type is APP_PROMOTION``objective_type is TRAFFIC and promotion_type is APP_IOS or APP_ANDROIDspecical_industries, objective_type is not PRODUCT_SALES, TikTok placement is selected, and auto_targeting_enabled is not true. The Saved Audience and ad group must have the same advertiser ID. Do not also pass targeting options already contained in the Saved Audience. Its device settings must not conflict with the ad group, such as Android versus ios14_targeting=IOS14_PLUS, or iOS versus an Android app. Use /dmp/saved_audience/list/ to diagnose targeting conflicts. Any saved age_groups must satisfy current age restrictions.SCHEDULE_START_END. Schedule end time (UTC+0), in the format of "YYYY-MM-DD HH:MM:SS". The end time cannot be later than "2038-01-01 00:00:00".REACH and VIDEO_VIEWS as objectives (objective_type) at the campaign level. Not supported when brand_safety_type is set to THIRD_PARTY.frequency, controls how often people see your ad (only available for REACH ads). See frequency fields for more.next_day_retention = conversion_bid_price/deep_cpa_bid. Value range is (0, 1]. Only valid when placements is PLACEMENT_PANGLE and secondary_optimization_event is NEXT_DAY_OPEN. Note: If you want to use this field, please pass in conversion_bid_price, deep_bid_type, and next_day_retention at the same time, and make sure the value of them meets the calculation formula. Otherwise there might be unexpected errors.schedule_type. Schedule start time (UTC+0), in the format of "YYYY-MM-DD HH:MM:SS". The start time can be up to 12 hours earlier than the current time, but cannot be later than "2028-01-01 00:00:00". Note: This field cannot be updated if the schedule_start_time for the ad group is earlier than the current time.bid_type is BID_TYPE_CUSTOM and billing_event is OCPM. Where you can set a target cost per conversion for oCPM (Optimized Cost per Mille). conversion_bid_price needs to be lower than budget set at the campaign level and ad group level. See Bidding-Bidding limits to learn more about the bid verification mechanism.objective_type) is one of the following objectives: APP_PROMOTION,WEB_CONVERSIONS (with is_search_campaign as false),TRAFFIC, and LEAD_GENERATION.When objective_type is LEAD_GENERATION, promotion_type needs to be set to LEAD_GENERATION.Placements: placement_type is set to PLACEMENT_TYPE_AUTOMATIC, or placement_type is set to PLACEMENT_TYPE_NORMAL and PLACEMENT_TIKTOK is included in placements.You want to use this field to update the value of this field from false to true. If is_search_campaign is true, you cannot update the value of this field from false to true. To learn more about Search Ads, see Automatic Search Placement.true, false. Note: Starting June, 2024, you can no longer enable Automatic targeting or Targeting expansion for your ad groups. To ensure a smooth API integration, we recommend you migrate to Smart Targeting.app_package_id field returned by Get Pangle block list. It only takes effect when Pangle placement is selected.schedule_start_time of the ad group has not been reached. schedule_start_time of the ad group has been reached, but the operation_status is DISABLE and the cost is 0. To retrieve the schedule_start_time and operation_status of an ad group, use /adgroup/get/. Content exclusion category IDs. You can use /tool/content_exclusion/get/ to get a list of content category IDs (excluded_category_list) that can be excluded from being displayed next to your ads. Note: Updating Brand Safety settings, including brand_safety_type, category_exclusion_ids, and vertical_sensitivity_id, is currently an allowlist-only feature. If you would like to access it, please contact your TikTok representative.true, false. To learn more about Smart audience and how to turn on Smart audience, see Smart Targeting.shopping_ads_retargeting_type is LAB3, you need to pass in either included_custom_actions or excluded_custom_actions.shopping_ads_retargeting_type is LAB3, you need to pass in either included_custom_actions or excluded_custom_actions.schedule_start_time of the ad group has not been reached. schedule_start_time of the ad group has been reached, but the operation_status is DISABLE and the cost is 0. To retrieve the schedule_start_time and operation_status of an ad group, use /adgroup/get/. Vertical sensitivity category ID. You can use /tool/content_exclusion/get/ to get a list of vertical categories containing sensitive content (vertical_sensitivity_list) that can be excluded from appearing next to your ads. Note: Updating Brand Safety settings, including brand_safety_type, category_exclusion_ids, and vertical_sensitivity_id, is currently an allowlist-only feature. If you would like to access it, please contact your TikTok representative.product_source is STORE, you can no longer use catalog_authorized_bc_id to update the ad group because it will be ignored. If you update existing ad group where product_source is STORE, the existing catalog_authorized_bc_id, if present for the ad groups, will no longer be returned.deep_funnel_optimization_status is ON. The event source type. Enum values: PIXEL: Pixel. OFFLINE: Offline Event Set.CRM: CRM Event Set. Note: When deep funnel optimization is enabled, you cannot update deep_funnel_event_source, deep_funnel_event_source_id, and deep_funnel_optimization_event.is_search_campaign is true. Whether to enable automated keywords and let the system automatically generate keywords after you add ads. This expands high-quality traffic to improve performance. View high-performing automated keywords in reporting. Supported values: true, false. Default value: false. Note: Automated keywords in Search Ads Campaigns are currently an allowlist-only feature. If you would like to access it, please contact your TikTok representative.AGE_13_17) in the US, Latin America, the European Economic Area, the UK, Switzerland, or Canada is not supported. In other scenarios, this field is not supported. See the description of age_groups for details. Enum values: true, false. Default value: false.deep_funnel_optimization_status is ON. Event Source ID. When deep_funnel_event_source is PIXEL, specify a Pixel ID via this field. To obtain a list of Pixels, use /pixel/list/.When deep_funnel_event_source is OFFLINE, specify an Offline Event Set ID via this field. To obtain a list of Offline Event Set IDs, use /offline/get/. When deep_funnel_event_source is CRM, specify a CRM Event Set ID via this field. To obtain a list of CRM Event Set IDs, use /crm/list/. Note: When deep funnel optimization is enabled, you cannot update deep_funnel_event_source, deep_funnel_event_source_id, and deep_funnel_optimization_event.optimization_goal) is Install (INSTALL) or Value (VALUE). For enum values, see Conversion events - Secondary-goal events. Note: When secondary_optimization_event is specified, you need to pass in deep_bid_type at the same time.shopping_ads_type is VIDEO and product_source is CATALOG. The retargeting type of shopping ads. Enum values: LAB1: Retargeting audiences who viewed products or added products to cart but didn’t purchase products. LAB2: Retargeting audiences who added products to cart but didn’t purchase products. LAB3: Retargeting audiences using custom combination. OFF: No retargeting.deep_funnel_optimization_status is ON. Deep funnel optimization event. To find out the supported values for Standard Events available for Pixels, Offline Event Sets, and CRM Event Sets, see the “Event name for ad creation” column in Supported Pixel events. To find the list of optimization events for a Pixel, use /pixel/list/ and check the returned optimization_event. Example: SHOPPING.purchase_intention_keyword_ids.promotion_type is LEAD_GENERATION. The status of deep funnel optimization. Deep funnel optimization optimizes both your upper funnel events and deeper funnel events. You can select a secondary event alongside the primary optimization event, which can help improve campaign effectiveness. Enum values: ON: To enable deep funnel optimization. OFF: To disable deep funnel optimization. Default value: OFF. To learn about how to configure deep funnel optimization for Lead Generation ads, see Lead Generation ad with optimization location as Instant Form and Lead Generation ad with optimization location as Website. Note: Deep funnel optimization with CRM events is currently an allowlist-only feature. If you would like to access it, please contact your TikTok representative. Deep funnel optimization with Pixel or Offline events is generally available.true, false. To learn more about Smart interests & behaviors and how to turn on Smart interests & behaviors, see Smart Targeting.package_id) by using the /pangle_audience_package/get/ endpoint. You need to set bind_type to EXCLUDE. Do not specify this field and included_pangle_audience_package_ids at the same time.package_id) by using the /pangle_audience_package/get/ endpoint. You need to set bind_type to INCLUDE. Do not specify this field and excluded_pangle_audience_package_ids at the same time.shopping_ads_retargeting_type is LAB1 or LAB2. Value range: 1, 2, 3, 7, 14, 30, 60, 90, 180.audience_ids. Valid only with shopping_ads_type=VIDEO, product_source=CATALOG, shopping_ads_retargeting_type in LAB1, LAB2, or LAB3, and provided audience_ids. OR targets members of either audience; AND targets members of both. Removing the custom audience after this is set automatically resets the relation to null.Output
Update the budgets of ad groups
Update the budgets of ad groups
TIKTOK_ADS_UPDATE_ADGROUP_BUDGETUpdate the budgets of ad groups. This operation can affect billing, credit, invoices, budgets, contracts, or payments; require explicit approval and an isolated account.Input Parameters
budget or scheduled_budget has to be set. To update the lifetime budgets of one or more ad groups, specify budget.To update the daily budgets or dynamic daily budgets of one or more ad groups, specify scheduled_budget. Information about the new lifetime budgets that you want to set for one or more ad groups. Max size: 20. Note: The changes to the lifetime budgets of one or more ad groups will take effect immediately.budget or scheduled_budget has to be set. To update the lifetime budgets of one or more ad groups, specify budget.To update the daily budgets or dynamic daily budgets of one or more ad groups, specify scheduled_budget. Information about the scheduled budget changes to the daily budgets or dynamic daily budgets of one or more ad groups. Max size: 20. Note: The scheduled budget changes will take effect from 00:00 a.m. the following day in the ad account’s time zone.Output
Update an R&F ad group
Update an R&F ad group
TIKTOK_ADS_UPDATE_ADGROUP_RFUpdate an R&F ad group. Availability may depend on TikTok allowlisting or account entitlement.Input Parameters
STANDARD_FEED, TOP_FEED. STANDARD_FEED refers to large inventory with normal CPM price while TOP_FEEDrefers to limited inventory with higher CPM price.frequency, together with frequency_schedule, controls how often people see your ad (only available for REACH ads). For example, frequency = 2 & frequency_schedule = 3 means “show ads no more than twice every 3 days”. The following conditions should be met:1 ≤ frequency ≤ frequency_schedule.1 ≤ frequency_schedule ≤ min (schedule_end_time - schedule_start_time, 30).The frequency cap determined by frequency and frequency_schedule does not exceed four times a day.objective_type of the campaign it belongs to must be RF_REACH.AGE_13_17 cannot be used. For enum values, see Appendix - Enumeration - Audience Age Range. In certain scenarios, creation of ad groups that target the age group 13-17 (AGE_13_17) in the US will not be allowed. See New age restrictions for ads on TikTok to learn more. If you use targeting options that are not supported for the age group 13-17 in the US and leave the age_groups field unspecified or set it as [], an error will occur. You need to explicitly specify the exact age groups that you want to target, such as AGE_18_24, in the field to avoid any errors.in_use field for the carrier is true. The carriers must be consistent with the location(s) that you want to target. For enum values (carrier_id), see Appendix - Carriers.audience_sub_type to REACH_FREQUENCY when creating or updating the audience. Note: You cannot use Lookalike Audience in R&F ads. Otherwise, an error will occur.STANDARD: even delivery; unavailable for View+ (optimization_goal=REACH, cpv_video_duration=SIX_SECONDS). SCHEDULE: delivery in specified periods and requires schedules. SEQUENCE: specified ad order and requires expected_orders. VIEW_OPTIMIZE: maximize view-through rate and available only for View+. OPTIMIZE: optimized delivery.unlimited. For enum values, see Enumeration - Connection Type.delivery_mode is set to SEQUENCE, the number of objects in this array represents the number of ads that you will specify the sequence for.device_price_ranges must not be specified. For enum values of device model IDs on different levels, please see Device Models. Note: Only active devices (is_active = True in the response of /tool/device_model/) can be used to create ads.EXPANDED_INVENTORY: most inappropriate and mature content removed; replaces NO_BRAND_SAFETY as the next-version default. STANDARD_INVENTORY: content appropriate for most brands. LIMITED_INVENTORY: no mature themes. Use /tool/region/ for eligible regions. Updating brand_safety_type, category_exclusion_ids, or vertical_sensitivity_id is allowlist-only and subject to pre-bid brand-safety update eligibility.FIXED_SHOW: Purchase to achieve a fixed amount of impressions.FIXED_REACH: Purchase to reach a fixed number of users.FIXED_BUDGE: Purchase with a fixed budget.YYYY-MM-DD HH:MM:SS. The time interval between schedule_start_time and schedule_end_time must not exceed 90 days. The value of this field must be at YYYY-MM-DD HH:59:59 for the time zone where the ad will be delivered. For instance, if an advertiser in the UTC-5 time zone wants to create an R&F ad group that ends delivery on November 10th, 2023, this field must be set to "2023-11-10 04:59:59".RF_REACH as objectives (objective_type) at the campaign level. Not supported when brand_safety_type is set to THIRD_PARTY.Not supported when feed_type is set to TOP_FEED.If you set rf_campaign_type to PULSE in /campaign/create/, then you must enter contextual tags of PREMIUM type in this field.frequency_schedule, together with frequency, controls how often people see your ad (only available for REACH ads). See frequency field for more.YYYY-MM-DD HH:MM:SS. The time interval between schedule_start_time and schedule_end_time must not exceed 90 days. The value of this field must be at YYYY-MM-DD HH:00:00 for the time zone where the ad will be delivered. For instance, if an advertiser in the UTC-5 time zone wants to create an R&F ad group that starts delivery on November 1st, 2023, this field must be set to "2023-11-01 05:00:00".audience_sub_type to REACH_FREQUENCY when creating or updating the audience. Note: You cannot use Lookalike Audience in R&F ads. Otherwise, an error will occur.schedule_start_time of the ad group has not been reached. schedule_start_time of the ad group has been reached, but the operation_status is DISABLE and the cost is 0. To retrieve the schedule_start_time and operation_status of an ad group, use /adgroup/get/. Content exclusion category IDs. You can use /tool/content_exclusion/get/ to get a list of content category IDs (excluded_category_list) that can be excluded from being displayed next to your ads. Note: Updating Brand Safety settings, including brand_safety_type, category_exclusion_ids, and vertical_sensitivity_id, is currently an allowlist-only feature. If you would like to access it, please contact your TikTok representative.Output
Update the statuses of ad groups
Update the statuses of ad groups
TIKTOK_ADS_UPDATE_ADGROUP_STATUSEnable, disable, or permanently delete up to 20 ad groups. Enabling may resume ad delivery and spend; allow_partial_success can leave only some requested ad groups changed.Input Parameters
DISABLE (pause), ENABLE (enable), DELETE (delete). Note: The status of deleted ad groups or ad groups in deleted campaigns cannot be modified.ENABLE and DISABLE operations are not supported for R&F ad groups.true, false. Default value: false. If this field is set to true and you specify an operation for multiple ad groups, the operation can succeed for only some of the specified ad groups. In this case, the ineligible ad groups will be filtered out.Output
Update the statuses of ads
Update the statuses of ads
Update Advertiser Account
Update Advertiser Account
TIKTOK_ADS_UPDATE_ADVERTISER_ACCOUNTUpdate one TikTok ad account’s name, contact, company, license, certificate, promotion-link, address, or billing tax-number metadata. This action cannot change budgets, funding, payment settings, or account status. Provide at least one metadata field to update.Input Parameters
company_name_editable through advertiser information; otherwise TikTok requires representative support.Output
Update Advertiser Budgets
Update Advertiser Budgets
TIKTOK_ADS_UPDATE_ADVERTISER_BUDGETSConsequential financial action that updates, resets, increments, deducts, or sets minimum budgets for ad accounts in a Business Center. These changes can alter or reset spend controls and may be irreversible; verify the Business Center, ad accounts, operation, and amounts before execution.Input Parameters
Output
Update an app
Update an app
TIKTOK_ADS_UPDATE_APPUpdate a mobile app configured for an advertiser. The retargeting attribution setting defaults to NON_RETARGETING when omitted.Input Parameters
Output
Update an Asset Group
Update an Asset Group
Update a Billing Group
Update a Billing Group
TIKTOK_ADS_UPDATE_BC_BILLING_GROUPUpdate Billing Group membership, name, email recipients, or default status. Providing new_billing_group_emails replaces the entire existing list, removing accounts changes invoice grouping, and is_primary changes the default group. Obtain explicit approval immediately before execution and verify every changed value.Input Parameters
Output
Update info of a BC member
Update info of a BC member
Link or unlink a pixel and ad accounts
Link or unlink a pixel and ad accounts
Update a blocked word
Update a blocked word
Update a campaign
Update a campaign
Update the operation statuses of campaigns
Update the operation statuses of campaigns
TIKTOK_ADS_UPDATE_CAMPAIGN_STATUSEnable, disable, or permanently delete campaigns. Enabling may resume ad delivery and spend; postback_window_mode is accepted only while disabling.Input Parameters
Output
Update Catalog
Update Catalog
Update a feed
Update a feed
TIKTOK_ADS_UPDATE_CATALOG_FEEDUpdate a catalog feed or schedule. INCREMENTAL preserves products omitted from the next import; OVERWRITE permanently removes omitted products, so confirm the complete source file before using it.Input Parameters
Output
Update Catalog Feed Schedule Status
Update Catalog Feed Schedule Status
TIKTOK_ADS_UPDATE_CATALOG_FEED_SCHEDULE_STATUSSet one catalog feed schedule to ON or OFF. Read the current status first because TikTok rejects an unchanged value; ON starts recurring ingestion.Input Parameters
Output
Update catalog products
Update catalog products
Update a product set
Update a product set
Update the statuses of comments
Update the statuses of comments
Update a Custom Conversion
Update a Custom Conversion
Update a Custom Audience
Update a Custom Audience
Update Lookalike Audiences
Update Lookalike Audiences
Update the name of an image
Update the name of an image
Update the name of a video
Update the name of a video
Update GMV Max Campaign
Update GMV Max Campaign
Update GMV Max Campaign Creatives
Update GMV Max Campaign Creatives
TIKTOK_ADS_UPDATE_GMV_MAX_CAMPAIGN_CREATIVESRemove creatives from a GMV Max campaign or add them back. Include spu_id_list for every item in a Product GMV Max campaign; campaign type is not part of this request.Input Parameters
Output
Update GMV Max Session
Update GMV Max Session
TIKTOK_ADS_UPDATE_GMV_MAX_CAMPAIGN_SESSIONUpdate documented budget or schedule fields for a max delivery or creative boost session. schedule_start_time applies to max delivery sessions.Input Parameters
Output
Update an Offline Event Set
Update an Offline Event Set
Update rules
Update rules
Update the statuses of rules
Update the statuses of rules
Update Pangle Block List
Update Pangle Block List
TIKTOK_ADS_UPDATE_PANGLE_BLOCK_LISTUpdate an advertiser’s Pangle app block list by adding apps, removing apps, or clearing the existing list before adding replacements. Provide at least one non-empty app list or set clear_old_app to true.Input Parameters
Output
Link ad accounts to a Payment Portfolio
Link ad accounts to a Payment Portfolio
TIKTOK_ADS_UPDATE_PAYMENT_PORTFOLIO_ADVERTISERLink up to 20 ad accounts to an Advanced Payment Portfolio, changing which centrally managed funds those accounts can use. Obtain explicit finance-owner approval immediately before execution and verify the portfolio, every ad account, same-client eligibility, and administrator access; the whole call fails for one invalid ID.Input Parameters
Output
Allocate the credit line to Payment Portfolios
Allocate the credit line to Payment Portfolios
TIKTOK_ADS_UPDATE_PAYMENT_PORTFOLIO_CREDIT_LINEChange the credit-line percentages allocated to up to 10 Payment Portfolios. This directly changes available advertising credit now and whenever the total credit line changes; obtain explicit finance-owner approval immediately before execution and verify every portfolio, used minimum, percentage, and the intended total allocation.Input Parameters
Output
Update a Pixel
Update a Pixel
Update a Pixel Event
Update a Pixel Event
Update Search Ad Negative Keyword
Update Search Ad Negative Keyword
Add or delete audience segment mappings
Add or delete audience segment mappings
Update Smart Creative Materials
Update Smart Creative Materials
TIKTOK_ADS_UPDATE_SMART_CREATIVE_MATERIALSUpdate current Smart Creative materials outside Smart+ campaigns. With patch_update=true, omitted top-level fields remain unchanged, but every provided array replaces the entire prior array; first read and resend all existing array items to avoid data loss. Automatically generated ad names cannot be updated. This does not target retired DYNAMIC ACO.Input Parameters
Output
Update Smart Creative Material Status
Update Smart Creative Material Status
Update Smart+ Ad
Update Smart+ Ad
Update Smart+ Ad Group
Update Smart+ Ad Group
TIKTOK_ADS_UPDATE_SMART_PLUS_ADGROUPUpdate an existing Smart+ ad group’s name, bid, budget, schedule, pacing, comment or sharing settings, and audience targeting. Omitted settings remain unchanged; at least one field to update must be provided.Input Parameters
Output
Update Smart+ Ad Group Budgets
Update Smart+ Ad Group Budgets
TIKTOK_ADS_UPDATE_SMART_PLUS_ADGROUP_BUDGETSUpdate immediate total budgets or next-day scheduled daily budgets for Upgraded Smart+ ad groups. Provide a non-empty budget or scheduled_budget list. For CBO campaigns where budget_optimize_on is true, a min_budget or max_budget or both must already be configured before a scheduled-budget update; non-CBO ad groups have no such prerequisite.Input Parameters
Output
Update Smart+ Ad Material Status
Update Smart+ Ad Material Status
Update Smart+ Campaign
Update Smart+ Campaign
Update the time of a split test
Update the time of a split test
Set or update the Brand Safety Hub settings of an ad account
Set or update the Brand Safety Hub settings of an ad account
TIKTOK_ADS_UPDATE_TIKTOK_INVENTORY_FILTERSSet or update an advertiser account’s Brand Safety Hub settings. Setting cover_all_ad_objectives to true is irreversible and cannot be reverted.Input Parameters
Output
Upload verification documents
Upload verification documents
Upload Business Certificate Image
Upload Business Certificate Image
Upload catalog products
Upload catalog products
Upload products via a file URL
Upload products via a file URL
TIKTOK_ADS_UPLOAD_CATALOG_PRODUCTS_BY_FILE_URLIngest a CSV catalog feed from a directly accessible HTTP or HTTPS URL. INCREMENTAL preserves omitted products; OVERWRITE permanently removes omitted products, so confirm the complete source file before using it.Input Parameters
Output
Upload Catalog Videos by File URL
Upload Catalog Videos by File URL
Upload an Audience File
Upload an Audience File
TIKTOK_ADS_UPLOAD_DMP_CUSTOM_AUDIENCE_FILEUpload a CSV or TXT customer file after verifying its supplied MD5 signature.Input Parameters
Output
Upload a file in chunks
Upload a file in chunks
Upload an image
Upload an image
Upload a piece of music
Upload a piece of music
Upload a file
Upload a file
Upload a video
Upload a video
Upload a playable asset
Upload a playable asset
TIKTOK_ADS_UPLOAD_PLAYABLEUpload a playable ZIP package or reference a file already in TikTok’s file repository. Direct packages must be 5 MB or smaller, contain index.html and config.json at the root, and must not load external network resources.Input Parameters
Output
Validate a URL
Validate a URL