TOOL API

custom_conversion_create

Creates a Custom Conversion for a Pixel or an App using rule-based conditions. You can create up to 1,000 Custom Conversions per ad account, and up to 100 per Pixel or per App. App-based custom conversions depend on app setup from /app/list/ and, for app event sources, the App must be a Self Attribution Network (SAN) App with `self_attribution_enabled=true`. Mapping App Custom Events to Standard Events during creation requires allowlist access; if `event_source_type` is `APP`, you are using a Custom Event, and the app is not allowlisted for Custom Event to Standard Event mapping, `optimization_event` is not supported.

ecommerceOAuth1 credits

Call information

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

Input parameters

advertiser_idrequired

Advertiser ID.

custom_event_type

Custom Event to associate with the Custom Conversion. Valid only when the Custom Event has been configured for the App or Pixel identified by `event_source_id`. When you specify `custom_event_type`, you must specify `optimization_event` at the same time to map the Custom Event to a Standard Event. For app event sources, if you create a custom conversion using a Custom Event, postbacks for the specified App Custom Event must already have been received or the request will fail.

description

Description of the Custom Conversion. Maximum 500 characters and cannot contain emoji.

event_source_idrequired

Event source ID. When `event_source_type` is `PIXEL`, specify a Pixel ID. When `event_source_type` is `APP`, specify the `app_platform_id` of a Self Attribution Network (SAN) App, and confirm the App returned by /app/list/ has `self_attribution_enabled=true`. The app can only be used with the TikTok App Events SDK.

event_source_typerequired

Event source type. Determines how `event_source_id` is interpreted and when `optimization_event` is required or supported.

namerequired

Name of the Custom Conversion. Must start with a letter and may include letters, numbers, spaces, underscores, or hyphens. Maximum 50 characters, no emoji. Do not use the name of a standard event. Duplicate Custom Conversion names within the same ad account are not allowed.

optimization_event

Standard Event to associate with the Custom Conversion. Required when `event_source_type` is `PIXEL`; required when `event_source_type` is `APP` and you are creating the custom conversion using a standard event; and required when `event_source_type` is `APP`, you are using a Custom Event through `custom_event_type`, and the app is allowlisted for mapping Custom Events to Standard Events. Not supported when all of the following are true: `event_source_type` is `APP`, you are creating the custom conversion using a Custom Event, and the app is not allowlisted for Custom Event to Standard Event mapping. When you specify `custom_event_type`, you must also specify `optimization_event` simultaneously. Mapping App Custom Events to Standard Events is currently an allowlist-only feature.

rulesrequired

Conversion rule definitions for the Custom Conversion. Only actions that satisfy these rules are counted as the Custom Conversion. Provide 1 to 10 rule objects.