TOOL API

smart_plus_adgroup_update

Updates an Upgraded Smart+ ad group via `/open_api/v1.3/smart_plus/adgroup/update/`. This endpoint supports incremental updates. Use `/smart_plus/adgroup/get/` to obtain the `adgroup_id` before updating. Some settings have campaign-wide effects or constraints: updating `bid_price`, `conversion_bid_price`, or `roas_bid` on one ad group automatically updates the corresponding bidding value for all other ad groups in the same campaign, and when Campaign Budget Optimization (CBO) is enabled (`budget_optimize_on=true`) these settings, if specified, must be the same across all ad groups in that campaign. The docs also include allowlist-only features such as postal code targeting in Brazil, Indonesia, Thailand, and Vietnam; `spc_audience_age=ALL`; and Goal-based budget increase (`budget_auto_adjust_strategy=AUTO_BUDGET_INCREASE`).

ecommerceOAuth1 credits

Call information

Tool slug
tiktok-ads.smart_plus_adgroup_update
Provider
TikTok for Business
Average response
0 ms
Calls in 7 days
0

Input parameters

adgroup_idrequired

Ad group ID to update. Obtain valid IDs from `/smart_plus/adgroup/get/`.

adgroup_name

Ad group name. Maximum length is 512 characters. Emoji is not supported.

advertiser_idrequired

Advertiser ID.

bid_price

Valid only when `optimization_goal` is `CLICK` and `bid_type` is `BID_TYPE_CUSTOM`. Target cost per click; the system aims to keep average CPC around or below this amount. `bid_price` must be lower than `budget`. Important: if multiple ad groups exist in the same campaign, updating `bid_price` on one ad group automatically updates `bid_price` for all other ad groups in that campaign. When CBO is enabled at the campaign level (`budget_optimize_on=true`), this setting, if specified, must be the same across all ad groups in the campaign.

budget

Fixed ad group budget or initial ad group budget. When `budget_auto_adjust_strategy` is `UNSET`, this is the fixed ad group budget. When `budget_auto_adjust_strategy` is `AUTO_BUDGET_INCREASE`, this is the initial ad group budget; use the returned `current_budget` to retrieve the current budget value.

budget_auto_adjust_strategy

Ad group budget strategy for custom ad group budget. Valid only when campaign-level `budget_optimize_on` is `false` and ad-group-level conditions are met: for `objective_type=APP_PROMOTION`, `budget_mode` must be `BUDGET_MODE_DYNAMIC_DAILY_BUDGET`, `optimization_goal` must be `VALUE`, `deep_bid_type` must be `VO_MIN_ROAS`, and `vbo_window` must be `ZERO_DAY`; for `objective_type=LEAD_GENERATION`, `budget_mode` must be `BUDGET_MODE_DYNAMIC_DAILY_BUDGET` and `bid_type` must be `BID_TYPE_CUSTOM`. `AUTO_BUDGET_INCREASE` enables Goal-based budget increase; when used, `budget` is the initial daily budget and may increase by 20% up to 10 times per day when budget utilization reaches 90% or more, then resets to the original daily budget each day. `UNSET` disables Goal-based budget increase. This feature is allowlist-only.

comment_disabled

Whether to disable comments on TikTok. Supported values: `true`, `false`.

conversion_bid_price

Valid only when `optimization_goal` is `CONVERT`, `TRAFFIC_LANDING_PAGE_VIEW`, `INSTALL`, or `IN_APP_EVENT`, and `bid_type` is `BID_TYPE_CUSTOM`. Target cost per conversion or landing page view; the system aims to keep average cost around or below this amount. `conversion_bid_price` must be lower than `budget`. Important: if multiple ad groups exist in the same campaign, updating `conversion_bid_price` on one ad group automatically updates the campaign's corresponding bid value for all other ad groups in that campaign. When CBO is enabled at the campaign level (`budget_optimize_on=true`), this setting, if specified, must be the same across all ad groups in the campaign.

dayparting

Ad delivery schedule as a 48 × 7 character string, where each character represents a 30-minute slot from Monday to Sunday: `1` for delivery and `0` for no delivery. The first character maps to Monday 00:01-00:30, the second to Monday 00:31-01:00, and the last to Sunday 23:31-00:00. An all-0 value, an all-1 value, or omitting this field is treated as full-time delivery.

is_hfss

Valid only when `targeting_optimization_mode` is `MANUAL`. Whether the promoted content is a HFSS (High Fat, Salt, Sugar) product or brand. Set to `true` if the ad promotes or prominently features HFSS content. In regulated regions, HFSS ads must target users aged 18 or over. You can set this field to `true` when targeting locations include the UK, Australia, New Zealand, or the European Union. Supported values: `true`, `false`.

is_lhf_compliance

Required and must be `true` when targeting locations include the UK and `is_hfss` is `true`. Confirms the promoted content complies with UK Less Healthy Foods regulations. By setting this field to `true`, you confirm that any food or drink products advertised on TikTok in the UK comply with the 2024 Less Healthy Foods Regulations and other applicable laws. Supported values: `true`, `false`.

roas_bid

Valid only when `deep_bid_type` is `VO_MIN_ROAS`. Target ROAS for Value-Based Optimization. Range: 0.01-1000. Important: if multiple ad groups exist in the same campaign, updating `roas_bid` on one ad group automatically updates the corresponding bidding value for all other ad groups in that campaign. When CBO is enabled at the campaign level (`budget_optimize_on=true`), this setting, if specified, must be the same across all ad groups in the campaign.

schedule_end_time

Valid only when `schedule_type` is `SCHEDULE_START_END`. Schedule end time in `YYYY-MM-DD HH:MM:SS` (UTC+0). The end time cannot be later than `2038-01-01 00:00:00`.

schedule_start_time

Schedule start time in `YYYY-MM-DD HH:MM:SS` (UTC+0). 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`.

schedule_type

Schedule type. `SCHEDULE_FROM_NOW` runs continuously after the scheduled start time. `SCHEDULE_START_END` runs only between the scheduled start and end times. You can set `schedule_type` to `SCHEDULE_START_END` only when `budget_mode` is `BUDGET_MODE_TOTAL` at the campaign level or at the ad group level.

share_disabled

Whether to disable sharing of the campaign to third-party platforms. Supported values: `true`, `false`.

suggestion_audience_enabled

Valid only when `targeting_optimization_mode` is `AUTOMATIC`. Whether to enable audience suggestions. When `true`, you can additionally specify `age_groups`, `gender`, `audience_ids`, `interest_category_ids`, `interest_keyword_ids`, `purchase_intention_keyword_ids`, and `actions` as suggestions for automatic targeting; delivery to those audiences is not guaranteed. If targeting settings do not align with `targeting_optimization_mode` and `suggestion_audience_enabled`, those settings are ignored without error. You cannot set this field to `true` if Realtime API (RTA) is enabled at the campaign level. Supported values: `true`, `false`.

targeting_optimization_mode

Audience targeting optimization mode. `AUTOMATIC` enables automatic targeting using real-time data and machine learning. When `targeting_optimization_mode` is `AUTOMATIC` and `suggestion_audience_enabled` is `false`, you can specify only these optional audience control settings: `location_ids`, `zipcode_ids`, `spc_audience_age`, `languages`, `operating_systems`, `excluded_audience_ids`. When `targeting_optimization_mode` is `AUTOMATIC` and `suggestion_audience_enabled` is `true`, you can additionally specify `age_groups`, `gender`, `audience_ids`, `interest_category_ids`, `interest_keyword_ids`, `purchase_intention_keyword_ids`, and `actions` as suggestions that guide automatic targeting. `MANUAL` enables custom targeting; when `targeting_optimization_mode` is `MANUAL`, you can specify `location_ids`, `zipcode_ids`, `age_groups`, `gender`, `languages`, `audience_ids`, `excluded_audience_ids`, `interest_category_ids`, `interest_keyword_ids`, `purchase_intention_keyword_ids`, `actions`, `smart_interest_behavior_enabled`, `smart_audience_enabled`, `spending_power`, `household_income`, `operating_systems`, `min_android_version`, `min_ios_version`, `device_model_ids`, `network_types`, `carrier_ids`, `isp_ids`, `device_price_ranges`, and `saved_audience_id`. If you specify targeting settings that do not align with `targeting_optimization_mode` and `suggestion_audience_enabled`, those settings are ignored without error.

targeting_spec

Targeting settings.