TOOL API

dmp_custom_audience_apply

Applies a custom audience to, or disconnects a custom audience from, multiple ad groups. This endpoint operates on ad groups under a single advertiser account. When applying an audience, you must also specify whether the audience should be included or excluded. Lookalike Audiences cannot be used with Reach & Frequency ads: an error occurs if `custom_audience_id` is a Lookalike Audience and any `adgroup_ids` are Reach & Frequency ad groups, or if `custom_audience_id` is a Lookalike Audience with the `REACH_FREQUENCY` audience subtype.

ecommerceOAuth1 credits

Call information

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

Input parameters

action_moderequired

Operation to perform on the audience. `Apply` applies the audience to the specified ad groups and requires `usage_mode` to specify whether the audience is included or excluded. `Disconnect` removes the audience from the specified ad groups and does not require `usage_mode`.

adgroup_idsrequired

List of ad group IDs to which the audience will be applied or from which it will be disconnected. `adgroup_ids` and `custom_audience_id` must belong to the same advertiser account, or an error occurs. Lookalike Audiences cannot be used in Reach & Frequency ads: an error occurs if `custom_audience_id` is a Lookalike Audience and any listed ad groups are Reach & Frequency ad groups, or if `custom_audience_id` is a Lookalike Audience with the `REACH_FREQUENCY` audience subtype.

advertiser_idrequired

Advertiser ID.

custom_audience_idrequired

Custom audience ID to apply or disconnect. Only one custom audience ID can be passed.

usage_mode

Whether to include or exclude the audience in the specified ad groups. Required when `action_mode` is `Apply`.