(To be deprecated) Update a Legacy Smart+ Campaign
Use this endpoint to update a Smart+ Campaign. Not all information of a Smart+ Campaign can be modified (For example, placement). The endpoint supports incremental updates.
> Note
> You can not update a Smart+ Campaign via /campaign/update/, /adgroup/update/, and /ad/update/.
> Important
> - Upgraded Smart+ API:
> - We are actively upgrading the Smart+ API to deliver enhanced capabilities and performance. The new Upgraded Smart+ API is already launched. Learn more about Upgraded Smart+ Campaign and available Upgraded Smart+ API endpoints.
> - Get started:
> - Reporting: No additional allowlist required.
> - Campaign Management: To access the upgraded Smart+ experience, contact your TikTok sales representative to have your ad account allowlisted. If your ad account is already in the allowlist, you can directly use the Upgraded Smart+ API creation and modification endpoints.
> - Legacy API Deprecation:
> - After March 31, 2026, you will no longer be able to create legacy Smart+ Campaigns using the /campaign/spc/create/ endpoint.
> - Note that legacy Smart+ Campaigns that have not been migrated will not be transitioned to the new API automatically. Attempts to use the legacy Smart+ API endpoint afterward will result in errors, rendering new campaign creation via this endpoint unavailable.
> - Legacy API deprecation extension request process for existing legacy Smart+ creation developers:
> - 1. Submit a request: If you require an extension, please submit an application via the External Extension Request Form for Legacy Smart+ Creation API.
> - 2. Allowlist processing: After receiving your request, we will process an allowlist entry for the associated developer app ID. After the process, developers will be able to continue calling the /campaign/spc/create/ endpoint until June 30, 2026.
> - 3. Extended timeline for strong business needs: If you have a strong business case requiring an extension beyond June 30, 2026, please specify your use case in the application form, or contact your sales representative directly.
Request
Endpoint
Authentication & shop
| Name | In | Type | Sample | Description |
|---|---|---|---|---|
| Authorization | header | header | Bearer q360_live_ab12cd34_… | Khóa API của brand (tạo ở mục API key). Bắt buộc với mọi request. Brand suy từ key — không truyền mã brand. |
| platform_shop_id | query | string | 7000000000000000001 | Tài sản TikTok Business đã kết nối — "Mã tài sản" ở trang Nền tảng hoặc GET /v1/platforms (tài khoản quảng cáo cho Marketing API, tài khoản TikTok cho Organic / Messaging). Có thể bỏ khi chỉ kết nối một tài sản. |
Request parameters
| Name | In | Type | Required | Sample | Description |
|---|---|---|---|---|---|
| campaign_id | body | string | Yes | Campaign ID. | |
| campaign_name | body | string | No | Campaign name. | |
| special_industries | body | string[] | No | Ad categories.
Enum values:
- HOUSING: Ads for real estate listings, homeowners insurance, mortgage loans or other related opportunities.
- EMPLOYMENT: Ads for job offers, internships, professional certification programs or other related opportunities.
- CREDIT: Ads for credit card offers, auto loans, long-term financing or other related opportunities.Note
- Currently, we only support clearing this field.
- This field is only supported for advertisers who are registered in America or Canada. | |
| product_specific_type | body | string | No | Different dimensions to choose products.
Enum values:
- ALL: Allow TikTok to dynamically choose from all products.
- PRODUCT_SET: Specify a product set. TikTok will dynamically choose products from this set.
- CUSTOMIZED_PRODUCTS: Specify a customized number of products.
- If this field is set to ALL, you don't need to input product_set_id and product_ids.
- If this field is set to PRODUCT_SET, you need to pass in product_set_id.
- If this field is set to CUSTOMIZED_PRODUCTS, product_ids is required. | |
| product_set_id | body | string | No | Required when product_specific_type is PRODUCT_SET.
The ID of a product set.
- To retrieve the product sets within your ad account, use /catalog/set/get/.
- To create a product set, use /catalog/set/create/. | |
| product_ids | body | string[] | No | Required when product_specific_type is product_ids.
The product IDs of the catalog products.
Max size: 20.
To retrieve the product ID (product_id) of each catalog product, use /catalog/product/get/. | |
| bid_price | body | float | No | Valid only when the following conditions are met:
- spc_type is WEB_ALL_IN_ONE
- optimization_goal is CLICK
- bid_type is BID_TYPE_CUSTOM
The target cost per click. The system will aim to get the most results while keeping the average cost per result around or lower than the specified amount.
bid_price needs to be lower than budget. See Bidding-Bidding limits to learn more about the bid verification mechanism. | |
| conversion_bid_price | body | float | No | Valid only when the following conditions are met:
- spc_type is WEB_ALL_IN_ONE
- optimization_goal is CONVERT or TRAFFIC_LANDING_PAGE_VIEW
- bid_type is BID_TYPE_CUSTOM
The target cost per conversion or cost per landing page view. The system will aim to get the most results while keeping the average cost per result around or lower than the specified amount.
conversion_bid_price needs to be lower than budget. See Bidding-Bidding limits to learn more about the bid verification mechanism. | |
| roas_bid | body | float | No | Target ROAS for Value-Based Optimization. Value range: 0.01-1,000. | |
| location_ids | body | string[] | No | IDs of the locations that you want to target. 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: If you add the US as your target location, then you can not remove the US after campaign creation. | |
| languages | body | string[] | No | Codes of the languages that you want to target. For the list of language codes supported, see Enumeration - Language Code. | |
| gender | body | string | No | Gender that you want to target.
Enum values: GENDER_FEMALE, GENDER_MALE, GENDER_UNLIMITED.
Note: The field is currently an allowlist-only feature. If you would like to access it, please contact your TikTok representative. | |
| spc_audience_age | body | string | No | The age group that the campaign targets.
Enum value:
- 18+: 18+.
- 25+: 25+.
- The value 25+ is only available when objective_type is LEAD_GENERATION. | |
| exclude_age_under_eighteen | body | boolean | No | Exclude the group aged under eighteen.
Note: Starting from September 21st, 2023, you can no longer target audience aged under eighteen.
The field can only be updated from false to true. | |
| excluded_audience_ids | body | string[] | No | List of audience IDs to be excluded. You can get audience IDs by using the /dmp/custom_audience/list/ endpoint. | |
| comment_disabled | body | boolean | No | Whether to allow comments on your campaigns on TikTok.
Supported values: true, false. | |
| share_disabled | body | boolean | No | Whether to disable sharing of the campaign to third-party platforms.
Supported values: true, false. | |
| blocked_pangle_app_ids | body | string[] | No | Pangle app block ID list.
You can get an ID via the app_package_id field returned by Get Pangle block list. | |
| budget_auto_adjust_strategy | body | string | No | Valid only when budget_mode is BUDGET_MODE_DYNAMIC_DAILY_BUDGET.
The daily budget strategy.
Enum values:
- AUTO_BUDGET_INCREASE: To enable automatic budget increase. Allow your budget to automatically increase when your ads are performing well and target CPA, Day 0 target ROAS, and budget requirements are met.
- When budget_auto_adjust_strategy is AUTO_BUDGET_INCREASE, the specified budget will be the initial daily budget. Your daily budget will be allowed to automatically increase by 20%, up to 10 times per day, when your budget utilization reaches 90% or more. Your daily budget will reset to your original daily budget each day.
- UNSET: To disable automatic budget increase.
Note: Enabling automatic budget increase is currently an allowlist-only feature. If you would like to access it, please contact your TikTok representative. | |
| budget | body | float | No | Fixed campaign budget or initial campaign budget.
- When budget_auto_adjust_strategy is UNSET, this field represents your fixed campaign budget.
- When budget_auto_adjust_strategy is AUTO_BUDGET_INCREASE, this field represents your initial campaign budget. To retrieve the current campaign budget, check the returned current_budget.
To learn about the minimum budget and how to set budget modes, see Budget.
To directly see the daily budget value range for a currency, see Currency-Daily budget value range. | |
| schedule_type | body | string | No | Schedule type.
Currently, we support SCHEDULE_START_END and SCHEDULE_FROM_NOW. | |
| schedule_start_time | body | string | No | Schedule start time, in the format of YYYY-MM-DD HH:MM:SS (UTC+0).
The start time can be up to 12 hours earlier than the current time. | |
| schedule_end_time | body | string | No | Schedule end time, in the format of YYYY-MM-DD HH:MM:SS (UTC+0). | |
| dayparting | body | string | No | Ad delivery arrangement, in the format of a string that consists of 48 x 7 characters. Each character is mapped to a 30-minute timeframe from Monday to Sunday. Each character can be set to either 0 or 1. 1 represents delivery in the 30-minute timeframe, and 0 stands for non-delivery in the 30-minute timeframe. The first character is mapped to 0:01-0:30 of Monday; The second character is mapped to 0:31-1:00 of Monday, and the last character represents 23:31-0:00 Sunday. Note: If not specified, all-0, or all-1 are considered as full-time delivery. | |
| identity_id | body | string | No | Identity ID when you are not using Spark Ads. | |
| media_info_list | body | object[] | No | List of media information. Max size: 30. | |
| dark_post_status | body | string | No | Valid only when you create Spark Ads through Spark Ads Push.
The status of the "Ads-only mode" for your creatives.
Enum values:
- ON: Enable the ads-only mode to limit your posts to paid traffic.
- OFF: Disable the ads-only mode. The post will appear on your TikTok profile and will be eligible to receive organic traffic.
Note: You can only set this field to OFF if the "Ads-only mode" is disabled for the identity. To confirm the "Ads-only mode" status of an identity, use /identity/info/ and check the returned ads_only_mode. | |
| catalog_creative_toggle | body | boolean | No | Valid only when web_all_in_one_catalog_status is OPEN.
Whether to enable auto-selection of creatives from your catalog.
Supported values: true, false.
Default value: false.
If you set this field to true, music_info is required and the system will use catalog creatives to automatically generate ads in diverse formats such as catalog video, catalog carousel, and single video. For detailed configuration options and requirements, see Customize ad format combinations in Smart+ Catalog Ads. | |
| title_list | body | object[] | No | List of ad titles (also called ad texts). Ad titles are shown to your audience as part of your ad creative, to deliver the message you intend to communicate to them. | |
| call_to_action_id | body | string | No | Required in any of the following scenarios:
- Scenario 1:
- objective_type is LEAD_GENERATION.
- Scenario 2:
- objective_type is APP_PROMOTION or WEB_CONVERSIONS.
- identity_type within the media_info object is TT_USER, BC_AUTH_TT, or AUTH_CODE.
The ID of the CTA portfolio that you want to use in your ads. A CTA portfolio is a group of auto-optimized CTAs.
For details about auto-optimized CTAs, see CTA recommendations > Dynamic CTAs. | |
| call_to_action_list | body | object[] | No | Call-to-action list.
Note: This field is not supported in any of the following scenarios and you need to use call_to_action_id instead.
- Scenario 1:
- objective_type is LEAD_GENERATION.
- Scenario 2:
- objective_type is APP_PROMOTION or WEB_CONVERSIONS.
- identity_type within the media_info object is TT_USER, BC_AUTH_TT, or AUTH_CODE. | |
| product_info | body | object | No | Additional product information. This information will be used to create ad variations to help achieve advertising goals such as standing out, building trust, or boosting performance. | |
| card_list | body | object[] | No | Creative portfolio ID list. Size range: 0-1. | |
| page_list | body | object[] | No | Page ID list. Size range: 0-1. | |
| deeplink_type | body | string | No | The deeplink type.
Currently, we only support DEFERRED_DEEPLINK.
Note: If you pass this field, you should also provide the deeplink field. | |
| deeplink | body | string | No | The specific location where you want your audience to go if they have your app installed.
Note: If you pass this field, you should also provide the deeplink_type field. | |
| landing_page_urls | body | object[] | No | Landing page URL list.
Before you use this field, please be aware of the following two modes. You can switch the ad between the two modes.
- Single landing page mode:
In this mode, all videos/TikTok posts have the same landing page. When you update a campaign to single landing page mode, the size range of this field is 0-1. Additionally, you don't need to specify video_id or tiktok_item_id in this object array.
- Multiple landing page mode:
This mode can only be used when objective_type = WEB_CONVERSIONS, promotion_type is WEBSITE and spc_type is UNSET or not passed. In this mode, each video/TikTok post corresponds to a landing page URL. When you create a campaign in multiple landing page mode, the size range of this field is 0-30, and the size must be equal to the number of videos. For instance, if updating a campaign with three videos (three objects in media_info_list), you must specify three objects in landing_page_urls. Additionally, you need to specify: either video_id when updating a non-Spark ad, or tiktok_item_id when updating a Spark Ad.
Note:
- If you update media_info_list in the request, you need to update landing_page_urls at the same time.
- Multiple landing page mode is currently an allowlist-only feature. If you would like to access it, please contact your TikTok representative. | |
| utm_params | body | object[] | No | Valid when objective_type is WEB_CONVERSIONS.
A list of URL parameters.
Max size: 14.
If you set landing_page_url to a URL that already includes URL parameters, you can optionally pass utm_params at the same time to store the URL parameters used in the URL. In such cases, you need to ensure that utm_params exactly matches the used URL parameters. The URL parameters will not be automatically appended to the landing_page_url upon ad delivery. | |
| disclaimer_info | body | object | No | Valid only when sales_destination is WEB_AND_APP.
Details of the disclaimer. | |
| tracking_app_id | body | string | No | Valid when objective_type is WEB_CONVERSIONS.
The ID of the App that you want to measure.
You can use this field to measure offsite app events.
To get a list of App IDs, use /app/list/. | |
| impression_tracking_url | body | string | No | Default Impression Tracking URL. URL generated by your data partner to track impression events in your ads. Generally you can find and copy the URL from their platform.
- If the partner ID for the App (app_id specified at the ad group level ) that you want to track is 44 (TikTok Business SDK) or 49 (TikTok App API), you don't need to pass in this field. If you do, this field will be ignored. You can obtain the partner ID of an App through partner_id returned from /app/list/ or /app/info/.
- If self-attribution has been enabled for the App (app_id specified at the ad group level ) that you want to track and the partner ID for the App is not 44 (TikTok Business SDK) or 49 (TikTok App API), you don't need to pass in this field because this field will default to the Default Impression Tracking URL you have configured for the App, and updates to the URL are not supported. You can check whether self-attribution has been enabled for the App through self_attribution_enabled returned from /app/list/ or /app/info/. | |
| click_tracking_url | body | string | No | Click Tracking URL. URL generated by your data partner to track click events in your ads. Generally you can find and copy the URL from their platform.
- If the partner ID for the App (app_id specified at the ad group level ) that you want to track is 44 (TikTok Business SDK) or 49 (TikTok App API), you don't need to pass in this field. If you do, this field will be ignored. You can obtain the partner ID of an App through partner_id returned from /app/list/ or /app/info/.
- If self-attribution has been enabled for the App (app_id specified at the ad group level ) that you want to track and the partner ID for the App is not 44 (TikTok Business SDK) or 49 (TikTok App API), you don't need to pass in this field because this field will default to the Click Tracking URL you have configured for the App, and updates to the URL are not supported. You can check whether self-attribution has been enabled for the App through self_attribution_enabled returned from /app/list/ or /app/info/. |
Request examples
curl -s -X POST "https://partner.quantri360.com/v1/tiktok_business/campaign/spc/update/" \
-H "Authorization: Bearer $KEY" \
-H "Content-Type: application/json" \
-d '{"campaign_id":"","media_info_list":[{}],"title_list":[{}],"call_to_action_list":[{}],"product_info":{},"card_list":[{}],"page_list":[{}],"landing_page_urls":[{}],"utm_params":[{}],"disclaimer_info":{}}'
Python
import requests
KEY = "q360_live_..." # khóa API của brand
r = requests.post(
"https://partner.quantri360.com/v1/tiktok_business/campaign/spc/update/",
params={},
json={
"campaign_id": "",
"media_info_list": [
{}
],
"title_list": [
{}
],
"call_to_action_list": [
{}
],
"product_info": {},
"card_list": [
{}
],
"page_list": [
{}
],
"landing_page_urls": [
{}
],
"utm_params": [
{}
],
"disclaimer_info": {}
},
headers={"Authorization": f"Bearer {KEY}"},
timeout=60,
)
print(r.status_code)
print(r.json())Node.js
const KEY = 'q360_live_...'; // khóa API của brand
const url = new URL('https://partner.quantri360.com/v1/tiktok_business/campaign/spc/update/');
for (const [k, v] of Object.entries({})) url.searchParams.set(k, typeof v === 'object' ? JSON.stringify(v) : String(v));
const r = await fetch(url, {
method: 'POST',
headers: { Authorization: `Bearer ${KEY}`, 'Content-Type': 'application/json' },
body: JSON.stringify({"campaign_id":"","media_info_list":[{}],"title_list":[{}],"call_to_action_list":[{}],"product_info":{},"card_list":[{}],"page_list":[{}],"landing_page_urls":[{}],"utm_params":[{}],"disclaimer_info":{}}),
});
console.log(r.status, await r.json());PHP
<?php
$key = 'q360_live_...'; // khóa API của brand
$url = 'https://partner.quantri360.com/v1/tiktok_business/campaign/spc/update/' . '?' . http_build_query([]);
$ch = curl_init($url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, ['Authorization: Bearer ' . $key, 'Content-Type: application/json']);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{"campaign_id":"","media_info_list":[{}],"title_list":[{}],"call_to_action_list":[{}],"product_info":{},"card_list":[{}],"page_list":[{}],"landing_page_urls":[{}],"utm_params":[{}],"disclaimer_info":{}}');
$res = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);
echo $status, "\n", $res;Response
Response fields (as returned by TikTok Business)
| Name | Type | Sample | Description |
|---|---|---|---|
| code | number | Response code. For the complete list of response codes and descriptions, see Appendix - Return Codes. | |
| message | string | Response message. For details, see Appendix - Return Codes. | |
| request_id | string | The log ID of the request, which uniquely identifies a request. | |
| data | object | Returned data. | |
| advertiser_id | string | Advertiser ID. | |
| campaign_id | string | Campaign ID. | |
| operation_status | string | The status of the campaign. Enum values: - `ENABLE` : The campaign is enabled. - `DISABLE` : The campaign is disabled. | |
| campaign_secondary_status | string | Campaign status (Secondary status). For the supported campaign secondary statuses for a certain primary status, see Supported secondary statuses for a primary status. It is equal to `secondary_status` in /campaign/get/. | |
| is_smart_performance_campaign | boolean | Whether the campaign is an automated campaign type. Supported values: - `true`: The campaign is either a Smart+ Campaign or a Smart Performance Web Campaign. - `false`: The campaign is a standard campaign type. Note: If `is_smart_performance_campaign` is `true` and `objective_type` is `WEB_CONVERSIONS`, you can confirm whether the web campaign is a Smart+ Web Campaign or Smart Performance Web Campaign by checking the returned `spc_type`. | |
| objective_type | string | Advertising objective. Currently, we support `APP_PROMOTION`, `WEB_CONVERSIONS`, and `LEAD_GENERATION`. | |
| spc_type | string | The web campaign type. Enum values: - `WEB_ALL_IN_ONE`: Smart+ Web Campaign, where the supported optimization goals include Conversion, Value, Click and Landing page view. - `UNSET`: Smart Performance Web Campaign, where the supported optimization goals are limited to Conversion, Value, and Click. | |
| web_all_in_one_catalog_status | string | The status of catalog in the Smart+ Web Campaign. Enum values: - `OPEN`: enabled. - `UNSET`: disabled. | |
| app_promotion_type | string | App promotion type. Currently, we only support `APP_INSTALL`. | |
| virtual_objective_type | string | The new objective type. Enum value: `SALES`. Use this field to create a campaign with the Sales objective, the combined objective for Website Conversions and Product Sales objectives. Learn more about the Sales objective. | |
| sales_destination | string | Sales destination, the destination where you want to drive your sales. Enum values: - `WEBSITE`: Website. Drive sales on your website. - `WEB_AND_APP`: Website and app. Drive sales on both your website and your app. | |
| campaign_type | string | Campaign Type. Currently, we support `REGULAR_CAMPAIGN` and `IOS14_CAMPAIGN`. | |
| campaign_app_profile_page_state | string | Indicates the status of the App Profile Page. Enum values: `INVALID`, `UNSET`, `ON`, `OFF`. | |
| is_advanced_dedicated_campaign | boolean | Whether the campaign is an Advanced Dedicated Campaign. Advanced Dedicated Campaigns leverage advanced delivery models that benefit from real-time signals. Enum values: `true`, `false`. | |
| disable_skan_campaign | boolean | Whether to disable SKAN (SKAdNetwork) attribution, Apple's conversion attribution solution for iOS campaigns. Enum values: - `true`: To disable SKAN attribution. The campaign will not be bound by Dedicated Campaign quota limits and you will be able to retrieve Self Attribution Network (SAN) metrics for the campaign. However, you cannot retrieve SKAN reporting metrics for the campaign. Learn more about SAN integration. - `false`: To enable SKAN attribution. The campaign will be bound by Dedicated Campaign quota limits and you will be able to retrieve SKAN metrics for the campaign. | |
| bid_align_type | string | The attribution type for the Dedicated Campaign. The type determines which attribution network the target CPA (`conversion_bid_price`) or ROAS (`roas_bid`) is based on. Enum values: - `SAN`: SAN. - `SKAN`: SKAN. | |
| campaign_name | string | Campaign name. | |
| special_industries | string[] | Ad categories. Enum values: - `HOUSING`: Ads for real estate listings, homeowners insurance, mortgage loans or other related opportunities. - `EMPLOYMENT`: Ads for job offers, internships, professional certification programs or other related opportunities. - `CREDIT`: Ads for credit card offers, auto loans, long-term financing or other related opportunities. | |
| adgroup_secondary_status | string | Ad group status (Secondary status). For the supported adgroup secondary statuses for a certain primary status, see Supported secondary statuses for a primary status. It is equal to `secondary_status` in /adgroup/get/. | |
| product_source | string | Product source where you want to get products for promotion. Enum value: `CATALOG` (catalog). | |
| catalog_id | string | The ID of the catalog to use in the Smart+ Catalog Ads. | |
| catalog_authorized_bc_id | string | The ID of the Business Center that the catalog (`catalog_id`) belongs to. | |
| product_specific_type | string | Different dimensions to choose products. Enum values: - `ALL`: Allow TikTok to dynamically choose from all products. - `PRODUCT_SET`: Specify a product set. TikTok will dynamically choose products from this set. - `CUSTOMIZED_PRODUCTS`: Specify a customized number of products. | |
| product_set_id | string | The ID of a product set. | |
| product_ids | string[] | The product IDs of the catalog products. | |
| promotion_type | string | Promotion type (Optimization location) and you can decide where you'd like to promote your products using this field. For value definitions, see Enumerations - Promotion Type. | |
| app_id | string | The App ID of the app to promote. You can get `app_id` by using the /app/list/ endpoint. | |
| app_type | string | The type of the promoted app. Currently, we support `APP_ANDROID` and `APP_IOS`. | |
| promotion_website_type | string | TikTok Instant Page type. Currently, we only support `TIKTOK_NATIVE_PAGE`(To use TikTok Instant Page). | |
| promotion_target_type | string | The optimization location for Lead Generation objective. 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. | |
| optimization_goal | string | The measurable results that you'd like to drive your ads with. For enum values, see Enumeration - Optimization Goal. | |
| pixel_id | string | Pixel ID. | |
| optimization_event | string | Conversion event for the ad group. See Conversion events for more. | |
| app_config | object[] | Returned when `sales_destination` is `WEB_AND_APP`. Details of the app or apps to promote. | |
| app_id | string | The App ID of the app to promote. | |
| deep_funnel_optimization_status | string | The status of deep funnel optimization. With deep funnel optimization, you can select a secondary event alongside the primary optimization event, which can help improve campaign effectiveness. Enum values: - `ON`: enabled. - `OFF`: disabled. | |
| deep_funnel_event_source | string | Returned when `deep_funnel_optimization_status` is `ON`. The event source type. Enum values: - `PIXEL`: Pixel. - `OFFLINE`: Offline Event Set. - `CRM`: CRM Event Set. | |
| deep_funnel_event_source_id | string | Returned when `deep_funnel_optimization_status` is `ON`. Event Source ID. - When `deep_funnel_event_source` is `PIXEL` , this field represents a Pixel ID. - When `deep_funnel_event_source` is `OFFLINE`, this field represents an Offline Event Set ID. - When `deep_funnel_event_source` is `CRM`, this field represents a CRM Event Set ID. | |
| deep_funnel_optimization_event | string | Returned when `deep_funnel_optimization_status` is `ON`. Deep funnel optimization event. Example: `SHOPPING`. | |
| bid_type | string | Bidding strategy. For enum values and their descriptions, see Enumeration - Bidding Strategy. | |
| bid_price | float | The target cost per click. The system will aim to get the most results while keeping the average cost per result around or lower than the specified amount. | |
| conversion_bid_price | float | The target cost per conversion or cost per landing page view. The system will aim to get the most results while keeping the average cost per result around or lower than the specified amount. | |
| deep_bid_type | string | Bidding strategy for in-app events. For enum values and their descriptions, see Enumeration - Deep Event Bidding Strategy. | |
| roas_bid | float | Target ROAS for Value-Based Optimization. | |
| incentive_offer_type | string | The type of incentive offer applicable to the Smart+ Campaign. If your campaign meets the eligibility criteria, but underperforms against certain CPA or Minimum ROAS thresholds you will be reimbursed with part of the gap with ad credits within the same ad account. To learn more about the incentive offer eligibility criteria and the calculation of incentive amount, see Smart+ Incentive Offer (Cost Cap/Minimum ROAS/Target ROAS). Enum values: - `INELIGIBLE`: The campaign is ineligible for any incentive offer. - `COST_CAP_AND_MIN_ROAS`: Ads groups within the campaign that use the Cost Cap or Minimum ROAS/Target ROAS bidding strategy are eligible for the incentive offer. | |
| vbo_window | string | The time window of the specified bidding strategy for VBO IAA (Value-Based Optimization for in-app advertising) or VBO IAP (Value-Based Optimization for in-app purchase). Enum values: - `SEVEN_DAYS`: The first seven days (day 7). - `ZERO_DAY`: The current day (day 0). | |
| click_attribution_window | string | Click-through window. This attribution window is the time between when a person clicks your ad and then takes an action. Enum values: - `OFF`: Off. - `ONE_DAY`: 1-day click. - `SEVEN_DAYS`: 7-day click. - `FOURTEEN_DAYS`: 14-day click. - `TWENTY_EIGHT_DAYS`: 28-day click. | |
| engaged_view_attribution_window | string | Engaged view-through window. This attribution window is the time after someone watches at least 6 seconds of your video ad that a conversion is counted. Enum values: - `ONE_DAY`: 1-day engaged view. - `SEVEN_DAYS`: 7-day engaged view. - `FOURTEEN_DAYS`: 14-day engaged view. - `TWENTY_EIGHT_DAYS`: 28-day engaged view. | |
| view_attribution_window | string | View-through window. This attribution window is the time between when a person views your ad and then takes an action. Enum values: - `OFF`: Off. - `ONE_DAY`: 1-day view. - `SEVEN_DAYS`: 7-day view. | |
| attribution_event_count | string | Event count (Statistic type). The way that people's actions are counted after only viewing or clicking an ad. Enum values: - `UNSET`: Unset. - `EVERY`: Every. To count multiple events from someone as separate conversions. - `ONCE`: Once. To count multiple events from someone as 1 conversion. | |
| billing_event | string | Bid method. See Enumerations - Bid method for optional values. | |
| location_ids | string[] | IDs of the locations that you want to target. Use Get locations to get available locations. | |
| languages | string[] | Codes of the languages that you want to target. For the list of language codes supported, see Enumerations - Language Code. | |
| gender | string | Gender that you want to target. Enum values: `GENDER_FEMALE`, `GENDER_MALE`, `GENDER_UNLIMITED`. | |
| spc_audience_age | string | The age group that the campaign targets. Enum value: `18+`, `25+`. - For campaigns with the `LEAD_GENERATION` objective (Smart+ Lead Generation Campaigns), the value of this field can be either `18+` or `25+`. - For campaigns with the `APP_PROMOTION` objective (Smart+ App Campaigns) or `WEB_CONVERSIONS` objective (Smart+ Web Campaigns or Smart Performance Web Campaigns), the value of this field can only be `18+`. Note: Currently, creating Smart+ Lead Generation Campaigns via API is not supported. To filter existing Smart+ Lead Generation Campaigns with the `LEAD_GENERATION` objective within your ad account, call /campaign/get/ and set `filtering` to `{"objective_type":"LEAD_GENERATION", "is_smart_performance_campaign": true}`. | |
| exclude_age_under_eighteen | boolean | Whether to exclude the group aged under eighteen. | |
| excluded_audience_ids | string[] | List of audience IDs to be excluded. | |
| placement_type | string | The placement strategy that decides where your ads will be shown. Currently, we support `PLACEMENT_TYPE_NORMAL` and `PLACEMENT_TYPE_AUTOMATIC`. | |
| placements | string[] | The apps where you want to deliver your ads. Currently, we support `PLACEMENT_TIKTOK` and `PLACEMENT_PANGLE`. | |
| comment_disabled | boolean | Whether to allow comments on your ads on TikTok. | |
| share_disabled | boolean | Whether sharing to third-party platforms is disabled for ads in this ad group. | |
| video_download_disabled | boolean | Whether users can download your video ads on TikTok. | |
| blocked_pangle_app_ids | string[] | Pangle app block ID list. | |
| brand_safety_type | string | Inventory filter tier for the Smart+ Campaign. Enum values: - `EXPANDED_INVENTORY`: Expanded inventory. Your ads will not appear next to explicitly inappropriate content, but they may appear next to content that features mature themes. - `STANDARD_INVENTORY`: Standard inventory. Your ads will appear next to content that is appropriate for most brands. - `LIMITED_INVENTORY`: Limited inventory. Your ads will not appear next to content that contains mature themes. - `NO_BRAND_SAFETY`: Full inventory without using any brand safety solution, which means your ads may appear next to some content featuring mature themes. Note: The setting is automatically applied based on your Brand Safety Hub configurations. To retrieve the details of such settings for your ad account, use /tiktok_inventory_filters/get/. | |
| category_exclusion_ids | string[] | The ID list of content categories that you want to avoid showing the Smart+ Campaign next to. To obtain the details of these content categories based on category IDs, use /tool/content_exclusion/info/. Note: The setting is automatically applied based on your Brand Safety Hub configurations. To retrieve the details of such settings for your ad account, use /tiktok_inventory_filters/get/. | |
| budget_mode | string | Budget mode. See Enumerations-Budget Mode. | |
| budget_auto_adjust_strategy | string | Returned only when `budget_mode` is `BUDGET_MODE_DYNAMIC_DAILY_BUDGET`. The campaign budget strategy for automatic daily campaign budget. Enum values: - `AUTO_BUDGET_INCREASE`: To enable automatic budget increase. Allow your budget to automatically increase when your ads are performing well and target CPA, Day 0 target ROAS, and budget requirements are met. - When `budget_auto_adjust_strategy` is `AUTO_BUDGET_INCREASE`, the specified `budget` will be the initial daily budget. Your daily budget will be allowed to automatically increase by 20%, up to 10 times per day, when your budget utilization reaches 90% or more. Your daily budget will reset to your original daily budget each day. - `UNSET`: To disable automatic budget increase. | |
| budget | float | Fixed campaign budget or initial campaign budget. - When `budget_auto_adjust_strategy` is `UNSET`, this field represents your fixed campaign budget. - When `budget_auto_adjust_strategy` is `AUTO_BUDGET_INCREASE`, this field represents your initial campaign budget. To retrieve the current campaign budget, check the returned `current_budget`. | |
| current_budget | float | Returned only when `budget_auto_adjust_strategy` is `AUTO_BUDGET_INCREASE`. Current campaign budget for a campaign with automatic budget increase enabled. | |
| scheduled_budget | float | Scheduled campaign budget for the next day. A value not equal to 0 means the scheduled budget is set and the value represents the budget; a value of 0 means the scheduled budget is not set. | |
| schedule_type | string | Schedule type. Currently, we support `SCHEDULE_START_END` and `SCHEDULE_FROM_NOW`. | |
| schedule_start_time | string | Ad delivery start time, in the format of`YYYY-MM-DD HH:MM:SS` (UTC+0). | |
| schedule_end_time | string | Ad delivery end time, in the format of`YYYY-MM-DD HH:MM:SS` (UTC+0). | |
| dayparting | string | Ad delivery arrangement, in the format of a string that consists of 48 x 7 characters. Each character is mapped to a 30-minute timeframe from Monday to Sunday. Each character can be set to either 0 or 1. 1 represents delivery in the 30-minute timeframe, and 0 stands for non-delivery in the 30-minute timeframe. The first character is mapped to 0:01-0:30 of Monday; The second character is mapped to 0:31-1:00 of Monday, and the last character represents 23:31-0:00 Sunday. Note: Not specified, all-0, or all-1 are considered as full-time delivery. | |
| skip_learning_phase | boolean | Whether to skip the learning phase. | |
| identity_id | string | Identity ID when you are not using Spark Ads. | |
| identity_type | string | Identity type when you are not using Spark Ads. Enum value: `CUSTOMIZED_USER`. | |
| app_download_url | string | App download link. | |
| app_name | string | The display name of the app download ad. | |
| media_info_list | object[] | List of media information. | |
| media_info | object | Material information. | |
| video_info | object | Video information. | |
| video_id | string | Video ID. | |
| file_name | string | Video name. | |
| image_info | object[] | Image information. | |
| web_uri | string | Image ID. | |
| music_info | object | Music information. | |
| music_id | string | The ID of the piece of music to use in the Carousel Ads. | |
| aigc_disclosure_type | string | Whether to turn on the AIGC (Artificial Intelligence Generated Content) self-disclosure toggle to indicate the ad contains AI-generated content. After the toggle is turned on, your ad will carry an "Advertiser labeled as Al-generated" label when viewed in full. Enum values: - `SELF_DISCLOSURE`: To turn on the toggle to declare that the ad contains AI-generated content. - `NOT_DECLARED`: To not declare that the ad contains AI-generated content. | |
| tiktok_item_id | string | The ID of the TikTok post to be used as an ad (Spark Ad). | |
| identity_type | string | Identity type when you use Spark Ads. Enum values: `AUTH_CODE`, `TT_USER`, `BC_AUTH_TT`. For details about identities, see Identities. | |
| identity_id | string | Identity ID when you use Spark Ads. | |
| identity_authorized_bc_id | string | Returned when `identity_type` is `BC_AUTH_TT`. ID of the Business Center that a TikTok Account User in Business Center identity is associated with. | |
| dark_post_status | string | The status of the "Ads-only mode" for your creatives. Enum values: - `ON`: Enable the ads-only mode to limit your posts to paid traffic. - `OFF`: Disable the ads-only mode. The post will appear on your TikTok profile and will be eligible to receive organic traffic. | |
| catalog_creative_toggle | boolean | Whether to enable auto-selection of creatives from your catalog. Supported values: `true`, `false`. If you set this field to `true`, the system will use catalog creatives to automatically generate ads in diverse formats such as catalog video, catalog carousel, and single video. | |
| title_list | object[] | List of ad titles (also called ad texts). Ad titles are shown to your audience as part of your ad creative, to deliver the message you intend to communicate to them. | |
| title | string | Ad title (ad text). | |
| call_to_action_id | string | The ID of the CTA portfolio that you want to use in your ads. | |
| call_to_action_list | object[] | Call-to-action list. | |
| call_to_action | string | Call-to-action text. For enum values, see Enumeration - Call-to-action. | |
| product_info | object | Additional product information. This information will be used to create ad variations to help achieve advertising goals such as standing out, building trust, or boosting performance. | |
| promo_info_list | object[] | Valid only in regular Smart+ Web Campaigns. Details of promo codes and offers. Promo codes and offers can help boost your ad performance. Make sure your codes and offers are active, accurate, and ready to use at checkout. | |
| discount_type | string | Returned when `promo_info_list` is specified. Discount type. Enum values: - `PERCENTAGE`: Percentage off discount. - `CASH`: Cash off discount. | |
| discount_value | string | Returned when `promo_info_list` is specified. Discount value. - When `discount_type` is `PERCENTAGE`, this field will be an integer between 1-100. - When `discount_type` is `CASH`, this field will be a float greater than 0. | |
| discount_currency | string | Returned when `discount_type` is `CASH`. Discount currency. For enum values, see List of values for `discount_currency` or `minimum_purchase_currency`. | |
| minimum_purchase_type | string | Minimum purchase type. Enum values: - `QUANTITY`: Minimum quantity. - `SUBTOTAL`: Minimum subtotal. | |
| minimum_purchase_value | float | Returned when `minimum_purchase_type` is specified. Minimum purchase value. - When `minimum_purchase_type` is `QUANTITY`, this field will be an integer that is 0 or greater. - When `minimum_purchase_type` is `SUBTOTAL`, this field will be a float greater than 0. | |
| minimum_purchase_currency | string | Returned when `minimum_purchase_type` is `SUBTOTAL`. Minimum purchase currency. For enum values, see List of values for `discount_currency` or `minimum_purchase_currency`. | |
| valid_start_time | string | Valid start time (UTC+0) for the promo code or offer, in the format of `YYYY-MM-DD HH:MM:SS`. | |
| valid_end_time | string | Valid end time (UTC+0) for the promo code or offer, in the format of `YYYY-MM-DD HH:MM:SS`. | |
| card_list | object[] | Creative portfolio ID list. | |
| card_id | string | Creative portfolio ID. | |
| automatic_add_on_enabled | boolean | Whether to enable auto-selection of interactive add-ons. Supported values: `true`, `false`. If you set this field to `true`, the system will automatically apply the most suitable interactive add-ons to your ads. | |
| page_list | object[] | Page ID list. | |
| page_id | string | Page ID. | |
| deeplink | string | The specific location where you want your audience to go if they have your app installed. | |
| deeplink_type | string | The deeplink type. | |
| landing_page_urls | object[] | Landing page URL list. | |
| landing_page_url | string | Landing page URL. | |
| video_id | string | Returned when the campaign is in multiple landing page mode. Video ID. | |
| tiktok_item_id | string | Returned when the campaign is in multiple landing page mode. The ID of the TikTok post to be used as an ad (Spark Ad). | |
| utm_params | object[] | A list of URL parameters. URL parameters are snippets of code that can be added to the end of the URLs to help you track clicks across different channels and understand how visitors interact with a website through third-party analytics platforms. They consist of key-value pairs that are specified through `key` and `value`. | |
| key | string | The URL parameter. The parameter can be a custom parameter or a UTM parameter. The supported UTM parameters are: - `utm_source`: The app, site, etc., that brings traffic to your website. For example: TikTok. - `utm_medium`: The advertising or marketing medium. For example: cpm, cpc, banner, and video. - `utm_content`: The creative content used for promotion. For example: ad name, CTA text, asset, and color. - `utm_campaign`: The individual campaign name, slogan, or promo code. For example: BlackFridayProm. Note that UTM parameters are case-sensitive. | |
| value | string | The value of the URL parameter. The value can be a custom value or the name of a macro. The supported macros are: - `__CAMPAIGN_NAME__`: This will be replaced by your campaign name. - `__CAMPAIGN_ID__`: This will be replaced by your campaign ID. - `__AID_NAME__`: This will be replaced by your ad group name. - `__AID__`: This will be replaced by your ad group ID. - `__CID_NAME__`: This will be replaced by your ad name. - `__CID__`: This will be replaced by your ad ID. - `__PLACEMENT__`: This will be replaced by your placement. | |
| disclaimer_info | object | Details of the disclaimer. | |
| disclaimer_type | string | The type of disclaimer that you want to add to the ad. Enum values: - `TEXT_LINK`: clickable disclaimers. - `TEXT_ONLY`: text-only disclaimers. | |
| disclaimer_text | object | Returned when `disclaimer_type` is `TEXT_ONLY`. The text-only disclaimer that you want to add to the ad. | |
| text | string | The disclaimer text. Length limit: 90 characters. | |
| disclaimer_clickable_texts | object[] | Returned when `disclaimer_type` is `TEXT_LINK`. The clickable disclaimer or clickable disclaimers that you want to add to the ad. | |
| text | string | The disclaimer text. Length limit: 40 characters. | |
| url | string | The URL for the clickable disclaimer. When users tap each text, they will be redirected to the URL and see more disclaimer details. | |
| tracking_app_id | string | The ID of the app that is measured. | |
| impression_tracking_url | string | Default Impression Tracking URL. | |
| click_tracking_url | string | Click Tracking URL. | |
| app_tracking_info_list | object[] | Details of Third-party tracking settings. | |
| app_type | string | Returned when `app_tracking_info_list` is specified. App type. Enum values: - `APP_ANDROID`: Android App. - `APP_IOS`: iOS App. | |
| app_id | string | Returned when `app_tracking_info_list` is specified. The App ID of the App. - When `app_type` is `APP_ANDROID`, this field represents the App ID for an Android App. - When `app_type` is `APP_IOS`, this field represents the App ID for an iOS App. | |
| impression_tracking_url | string | Impression tracking URL. When `app_type` is `APP_ANDROID`, this field represents an impression tracking URL for Android. - - When `app_type` is `APP_IOS`, this field represents an impression tracking URL for iOS. | |
| click_tracking_url | string | Click tracking URL. - When `app_type` is `APP_ANDROID`, this field represents a click tracking URL for Android. - When `app_type` is `APP_IOS`, this field represents a click tracking URL for iOS. | |
| create_time | string | The time when the campaign was created, in the format of `YYYY-MM-DD HH:MM:SS` (UTC+0). | |
| modify_time | string | The time when the campaign was modified, in the format of `YYYY-MM-DD HH:MM:SS` (UTC+0). |
Response sample
HTTPS/1.1 200 OK
{
"code": 0,
"message": "OK",
"request_id": "{{request_id}}",
"data": {
"campaign_id": "{{campaign_id}}",
"advertiser_id": "{{advertiser_id}}",
"app_id": "{{app_id}}",
"pixel_id": null,
"app_type": "APP_ANDROID",
"objective_type": "APP_PROMOTION",
"campaign_name": "{{campaign_name}}",
"is_smart_performance_campaign": true,
"operation_status": "ENABLE",
"campaign_secondary_status": "CAMPAIGN_STATUS_ENABLE",
"adgroup_secondary_status": "ADGROUP_STATUS_CREATE",
"campaign_type": "REGULAR_CAMPAIGN",
"app_promotion_type": "APP_INSTALL",
"optimization_goal": "CLICK",
"bid_type": "BID_TYPE_NO_BID",
"deep_bid_type": null,
"skip_learning_phase": null,
"budget": {{budget}},
"budget_mode": "BUDGET_MODE_DAY",
"scheduled_budget": {{scheduled_budget}},
"promotion_type": "APP_ANDROID",
"optimization_event": "ACTIVE",
"placements": [
"PLACEMENT_TIKTOK"
],
"placement_type": "PLACEMENT_TYPE_NORMAL",
"promotion_website_type": null,
"comment_disabled": true,
"share_disabled": true,
"video_download_disabled": true,
"location_ids": [
"{{location_ids}}"
],
"languages": [
"{{languages}}"
],
"exclude_age_under_eighteen": false,
"excluded_audience_ids": null,
"blocked_pangle_app_ids": null,
"special_industries": null,
"schedule_type": "SCHEDULE_FROM_NOW",
"schedule_start_time": "2024-04-17 22:00:00",
"schedule_end_time": "2034-04-15 22:00:00",
"dayparting": "111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111",
"billing_event": "CPC",
"app_download_url": "{{app_download_url}}",
"app_name": "{{app_name}}",
"call_to_action_id": null,
"call_to_action_list": [
{
"call_to_action": "INSTALL_NOW"
},
{
"call_to_action": "DOWNLOAD_NOW"
}
],
"media_info_list": [
{
"media_info": {
"video_info": {
"video_id": "{{video_id}}",
"file_name": "{{file_name}}"
},
"identity_id": null,
"image_info": [
{
"web_uri": "{{web_url}}"
}
],
"identity_type": null,
"tiktok_item_id": null
}
}
],
"title_list": [
{
"title": "{{title}}"
},
{
"title": "{{title}}"
}
],
"page_list": null,
"card_list": null,
"landing_page_urls": null,
"deeplink": "{{deeplink}}",
"deeplink_type": "DEFERRED_DEEPLINK",
"identity_id": "{{identity_id}}",
"identity_type": "CUSTOMIZED_USER",
"impression_tracking_url": null,
"click_tracking_url": "{{click_tracking_url}}",
"create_time": "{{create_time}}",
"modify_time": "{{modify_time}}"
}
}
Get started
- Sign up for Partner
- Enable a data type of the Ads (Marketing API) group on the platform page
- Create an API key (tick the TikTok Business channel)
- Call it as in the examples above