TOOL API

pixel_update

Updates a pixel's name and optional matching/cookie/data-sharing settings via `/open_api/v1.3/pixel/update/`. Pixel names should correspond to your website or domain name, must be unique, and must not exceed 40 characters. By using Events API endpoints, you agree to the TikTok Business Products (Data) Terms at https://ads.tiktok.com/i18n/official/policy/business-products-terms and must not share sensitive data with TikTok. Compared with v1.2, v1.3 changes `advertiser_id` from number to string and adds `automatic_advanced_matching_fields`, `enable_first_party_cookies`, and `enable_expanded_data_sharing`.

ecommerceOAuth1 credits

Call information

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

Input parameters

advanced_matching_fields

Manual Advanced Matching settings for the pixel. This object is only applicable to pixels generated through partner integrations and does not apply to manually configured pixels. When `advanced_matching_fields` is specified, both `phone_number` and `email` are required.

advertiser_idrequired

Advertiser ID.

automatic_advanced_matching_fields

Automatic Advanced Matching settings for the pixel. Automatic Advanced Matching uses customer information collected through your TikTok Pixel, such as email, name, and phone number, to improve match rates, conversion tracking, and retargeting. Sensitive information is hashed before it is shared with TikTok. If you operate in a more regulated or sensitive industry such as financial services or health care, consider using Manual Advanced Matching instead. When `automatic_advanced_matching_fields` is specified, all of `phone_number`, `email`, `name`, `address`, and `external_id` are required.

enable_expanded_data_sharing

Whether to enable expanded data sharing. When enabled, this pixel can collect more information from your website, including page content such as meta tags and product details, visitor actions such as clicks, button interactions, and time spent, and website performance such as page load speed and responsiveness. This data may be used to improve ad delivery and campaign performance on TikTok. You can view collected data in TikTok Pixel Helper.

enable_first_party_cookies

Whether to allow first-party cookies. When enabled, the system can share data from your website's first-party cookies with TikTok to improve measurement and help reach more users.

pixel_idrequired

Pixel ID.

pixel_namerequired

Pixel name. Must be unique, should correspond to your website/domain name, must be 40 characters or fewer, and cannot contain emojis. If you want to keep the name unchanged, set this field to an empty string (`""`).