TikTok Ads
The 108 tools Pilot MCP serves for TikTok Ads: 58 read-only, and 50 that write with the €29 plan, taken from the server.
Pilot MCP serves 58 read-only tools for TikTok Ads, on every plan. With the €29 plan, it also serves 37 that create or change and 13 that delete. Their names start with tiktok_.
What each entry shows
The name, description and parameters come from the list the server serves to your assistant (tools/list). Descriptions are in English: this is the text your assistant receives. Your assistant never fills in platform credentials: Pilot adds them on each call.
Writing and deleting
Write tools are only served with the €29 plan: your assistant creates, changes, pauses and deletes there, with no access level to pick when you connect. On the free plan, it does not see them. A change that sets an object to deleted or archived counts as a deletion, and a deletion targets one object at a time. Changes apply directly on the ad platform: Pilot reads the object from the platform before and after the write, and logs it in your workspace. See Read and write.
Tool families
| Family | Tools |
|---|---|
| Other tools | 58 |
| Create and change (€29) | 37 |
| Delete (€29) | 13 |
Other tools
tiktok_create_async_report
TikTok Ads: Create Async Report · read-only · creates an object on each call
Create an asynchronous TikTok report task (report type, dimensions, metrics, data level, dates); returns the task to check.
| Parameter | Type | Required | Description |
|---|---|---|---|
advertiser_id | string | no | Advertiser ID. |
report_type | string | no | Report type. |
dimensions | string[] | no | Dimensions. |
metrics | string[] | no | Metrics. |
data_level | string | no | Data level. |
start_date | string | no | Start date. |
end_date | string | no | End date. |
tiktok_download_async_report
TikTok Ads: Download Async Report · read-only · idempotent
Download the result of a completed asynchronous TikTok report task by task_id.
| Parameter | Type | Required | Description |
|---|---|---|---|
advertiser_id | string | no | Advertiser ID. |
task_id | string | yes | Report task ID, returned by create_async_report. |
tiktok_estimate_audience_size
TikTok Ads: Estimate Audience Size · read-only · idempotent
Estimate audience size for targeting criteria
| Parameter | Type | Required | Description |
|---|---|---|---|
advertiser_id | string | no | Advertiser ID. |
placements | string[] | no | Placements. |
location_ids | string[] | no | Location IDs. |
gender | string | no | Gender targeting. |
age_groups | string[] | no | Age groups. |
interest_category_ids | string[] | no | Interest category IDs. |
custom_audience_ids | string[] | no | Custom audience IDs (sent as audience_ids). |
objective_type | string | yes | Objective type, required by TikTok, e.g. TRAFFIC, CONVERSIONS, REACH. |
optimization_goal | string | yes | Optimization goal, required by TikTok, e.g. CLICK, CONVERT, REACH. |
tiktok_get_account_status
TikTok Ads: Get Account Status · read-only · idempotent
Get detailed account status including any restrictions, punishments, or compliance issues
| Parameter | Type | Required | Description |
|---|---|---|---|
advertiser_id | string | yes | Advertiser ID. |
tiktok_get_action_categories
TikTok Ads: Get Action Categories · read-only · idempotent
Get the TikTok action categories (behaviors) available for targeting, optionally for special ad categories.
| Parameter | Type | Required | Description |
|---|---|---|---|
advertiser_id | string | no | Advertiser ID. |
special_industries | string[] | no | Special ad categories: HOUSING, EMPLOYMENT, CREDIT (optional). |
tiktok_get_ad_groups
TikTok Ads: Get Ad Groups · read-only · idempotent
Get the ad groups of a TikTok advertiser, filtered by campaign IDs, ad group IDs or status; paginated.
| Parameter | Type | Required | Description |
|---|---|---|---|
advertiser_id | string | no | Advertiser ID. |
campaign_ids | string[] | no | Filter by campaign IDs. |
adgroup_ids | string[] | no | Filter by ad group IDs. |
primary_status | string | no | Filter by status. |
page | number | no | Page number. |
page_size | number | no | Page size. |
tiktok_get_ad_performance
TikTok Ads: Get Ad Performance · read-only · idempotent
Get TikTok performance data per ad over a date range (spend, impressions, clicks, CTR, CPC, CPM, conversions, video plays), optionally by campaign or ad group.
| Parameter | Type | Required | Description |
|---|---|---|---|
advertiser_id | string | yes | Advertiser ID. |
campaign_id | string | no | Filter by campaign ID. |
adgroup_id | string | no | Filter by ad group ID. |
start_date | string | yes | Start date (YYYY-MM-DD). |
end_date | string | yes | End date (YYYY-MM-DD). |
tiktok_get_adgroup_performance
TikTok Ads: Get Ad Group Performance · read-only · idempotent
Get performance data for ad groups within a campaign
| Parameter | Type | Required | Description |
|---|---|---|---|
advertiser_id | string | yes | Advertiser ID. |
campaign_id | string | no | Campaign ID to filter by. |
start_date | string | yes | Start date (YYYY-MM-DD). |
end_date | string | yes | End date (YYYY-MM-DD). |
tiktok_get_ads
TikTok Ads: Get Ads · read-only · idempotent
Get the ads of a TikTok advertiser, filtered by campaign, ad group or ad IDs, or by status; paginated.
| Parameter | Type | Required | Description |
|---|---|---|---|
advertiser_id | string | no | Advertiser ID. |
campaign_ids | string[] | no | Filter by campaign IDs. |
adgroup_ids | string[] | no | Filter by ad group IDs. |
ad_ids | string[] | no | Filter by ad IDs. |
primary_status | string | no | Filter by status. |
page | number | no | Page number. |
page_size | number | no | Page size. |
tiktok_get_advertiser_balance
TikTok Ads: Get Advertiser Balance · read-only · idempotent
Get balance information for an advertiser
| Parameter | Type | Required | Description |
|---|---|---|---|
advertiser_id | string | no | Advertiser ID. |
tiktok_get_advertiser_info
TikTok Ads: Get Advertiser Info · read-only · idempotent
Get information about an advertiser account
| Parameter | Type | Required | Description |
|---|---|---|---|
advertiser_ids | string[] | no | List of advertiser IDs. |
tiktok_get_age_gender_performance
TikTok Ads: Get Age Gender Performance · read-only · idempotent
Get performance breakdown by age group and gender
| Parameter | Type | Required | Description |
|---|---|---|---|
advertiser_id | string | yes | Advertiser ID. |
start_date | string | yes | Start date. |
end_date | string | yes | End date. |
tiktok_get_app_optimization_events
TikTok Ads: Get App Optimization Events · read-only · idempotent
Get the optimization events available for one TikTok app (app_id).
| Parameter | Type | Required | Description |
|---|---|---|---|
advertiser_id | string | no | Advertiser ID. |
app_id | string | no | App ID. |
tiktok_get_apps
TikTok Ads: Get Apps · read-only · idempotent
Get the apps registered for a TikTok advertiser.
| Parameter | Type | Required | Description |
|---|---|---|---|
advertiser_id | string | no | Advertiser ID. |
tiktok_get_async_report_status
TikTok Ads: Get Async Report Status · read-only · idempotent
Check the status of an asynchronous TikTok report task by task_id.
| Parameter | Type | Required | Description |
|---|---|---|---|
advertiser_id | string | no | Advertiser ID. |
task_id | string | yes | Report task ID, returned by create_async_report. |
tiktok_get_audience_report
TikTok Ads: Get Audience Report · read-only · idempotent
Get audience insights report (uses integrated reporting with AUDIENCE type)
| Parameter | Type | Required | Description |
|---|---|---|---|
advertiser_id | string | no | Advertiser ID. |
dimensions | string[] | no | Audience dimensions (gender, age, country_code, language, platform, etc.). |
metrics | string[] | no | Metrics to include. |
start_date | string | no | Start date (YYYY-MM-DD). |
end_date | string | no | End date (YYYY-MM-DD). |
data_level | string | no | Data level (AUCTION_AD, AUCTION_ADGROUP, AUCTION_CAMPAIGN, AUCTION_ADVERTISER). |
campaign_ids | string[] | no | Filter by campaign IDs. |
adgroup_ids | string[] | no | Filter by ad group IDs. |
page | number | no | Page number. |
page_size | number | no | Page size (1-1000). |
tiktok_get_authorized_ad_accounts
TikTok Ads: Get Authorized Ad Accounts · read-only · idempotent
Get ad accounts authorized to a business center
| Parameter | Type | Required | Description |
|---|---|---|---|
bc_id | string | yes | Business Center ID (required by TikTok). |
page | number | no | Page number. |
page_size | number | no | Page size. |
account_id | string | no | TikTok Ads account to use when the workspace has several, as returned by the account listing tool. Default: the first account linked to the workspace. |
tiktok_get_automation_rule
TikTok Ads: Get Automation Rule · read-only · idempotent
Get ONE automated rule by its ID (conditions, actions, apply objects, notification, schedule)
| Parameter | Type | Required | Description |
|---|---|---|---|
advertiser_id | string | yes | Advertiser ID. |
rule_id | string | yes | Rule ID. |
tiktok_get_automation_rules
TikTok Ads: Get Automation Rules · read-only · idempotent
List automated rules for an advertiser (auto-pause, budget adjustment, etc.)
| Parameter | Type | Required | Description |
|---|---|---|---|
advertiser_id | string | yes | Advertiser ID. |
page | number | no | Page number. |
page_size | number | no | Page size. |
tiktok_get_basic_report
TikTok Ads: Get Basic Report · read-only · idempotent
Get a TikTok integrated (synchronous) performance report: chosen dimensions and metrics at a data level, over a date range or lifetime.
| Parameter | Type | Required | Description |
|---|---|---|---|
advertiser_id | string | no | Advertiser ID. |
report_type | string | no | Report type (BASIC, AUDIENCE, PLAYABLE, CATALOG). |
dimensions | string[] | no | Dimensions (ad_id, adgroup_id, campaign_id, stat_time_day, stat_time_hour, country_code, etc.). |
metrics | string[] | no | Metrics (spend, impressions, clicks, ctr, cpc, cpm, reach, conversion, etc.). VALUE AND ROAS depend on the event source: website purchases = complete_payment (count), total_complete_payment_rate (purchase VALUE on the website, an amount despite its name), complete_payment_roas; app purchases = total_purchase, total_purchase_value, total_active_pay_roas; website leads = form, total_form_value; TikTok instant-form leads = onsite_form, total_onsite_form_value; website registrations = user_registration, total_user_registration_value. When every value is 0 the conversions have no amount: say so and give the cost per conversion, never a ROAS of 0. |
data_level | string | no | Data level (AUCTION_AD, AUCTION_ADGROUP, AUCTION_CAMPAIGN, AUCTION_ADVERTISER). |
start_date | string | no | Start date (YYYY-MM-DD). |
end_date | string | no | End date (YYYY-MM-DD). |
lifetime | boolean | no | Get lifetime data (sent to TikTok as query_lifetime; start_date/end_date are then ignored). |
filters | object | no | Filters as {"campaign_ids":[...],"adgroup_ids":[...],"ad_ids":[...]} (arrays of IDs, up to 100 each); sent to TikTok as the v1.3 `filtering` array. |
page | number | no | Page number. |
page_size | number | no | Page size. |
tiktok_get_campaign_performance_summary
TikTok Ads: Get Campaign Performance Summary · read-only · idempotent
Get a full performance summary for all campaigns with key metrics (spend, conversions, CTR, CPC). Handles metric validation and date limits automatically.
| Parameter | Type | Required | Description |
|---|---|---|---|
advertiser_id | string | yes | Advertiser ID. |
start_date | string | yes | Start date (YYYY-MM-DD). |
end_date | string | yes | End date (YYYY-MM-DD). |
include_daily | boolean | no | Include daily breakdown (default false). |
tiktok_get_campaigns
TikTok Ads: Get Campaigns · read-only · idempotent
Get the campaigns of a TikTok advertiser, filtered by campaign IDs, status or objective type; paginated (page 1, 10 per page by default).
| Parameter | Type | Required | Description |
|---|---|---|---|
advertiser_id | string | no | Advertiser ID. |
campaign_ids | string[] | no | Filter by campaign IDs. |
primary_status | string | no | Filter by status (STATUS_ENABLE, STATUS_DISABLE, STATUS_DELETE). |
objective_type | string | no | Filter by objective type. |
page | number | no | Page number. |
page_size | number | no | Page size. |
tiktok_get_carriers
TikTok Ads: Get Carriers · read-only · idempotent
Get the mobile carriers available for TikTok targeting for an advertiser.
| Parameter | Type | Required | Description |
|---|---|---|---|
advertiser_id | string | no | Advertiser ID. |
tiktok_get_comments
TikTok Ads: Get Comments · read-only · idempotent
Get the comments on a TikTok advertiser's ads, optionally by ad IDs; paginated.
| Parameter | Type | Required | Description |
|---|---|---|---|
advertiser_id | string | no | Advertiser ID. |
ad_ids | string[] | no | Ad IDs to get comments for. |
page | number | no | Page number. |
page_size | number | no | Page size. |
tiktok_get_creative_performance
TikTok Ads: Get Creative Performance · read-only · idempotent
Get performance by creative/ad to identify top and bottom performing creatives
| Parameter | Type | Required | Description |
|---|---|---|---|
advertiser_id | string | yes | Advertiser ID. |
start_date | string | yes | Start date. |
end_date | string | yes | End date. |
campaign_id | string | no | Filter by campaign ID. |
tiktok_get_creatives
TikTok Ads: Get Creatives · read-only · idempotent
Get ad creatives with their media assets (images, videos, text, CTA). Fetches ads with full creative details.
| Parameter | Type | Required | Description |
|---|---|---|---|
advertiser_id | string | yes | Advertiser ID. |
campaign_ids | string[] | no | Filter by campaign IDs. |
adgroup_ids | string[] | no | Filter by ad group IDs. |
ad_ids | string[] | no | Filter by ad IDs. |
page | number | no | Page number. |
page_size | number | no | Page size. |
tiktok_get_custom_audience
TikTok Ads: Get Custom Audience · read-only · idempotent
Get ONE TikTok audience by custom_audience_id (any type: customer file, rule, lookalike): name, validity, expiry, sharing, rule.
| Parameter | Type | Required | Description |
|---|---|---|---|
advertiser_id | string | yes | Advertiser ID. |
custom_audience_id | string | yes | Audience ID. |
tiktok_get_custom_audiences
TikTok Ads: Get Custom Audiences · read-only · idempotent
Get the custom audiences of a TikTok advertiser, optionally by audience IDs; paginated.
| Parameter | Type | Required | Description |
|---|---|---|---|
advertiser_id | string | no | Advertiser ID. |
custom_audience_ids | string[] | no | Filter by audience IDs. |
page | number | no | Page number. |
page_size | number | no | Page size. |
tiktok_get_daily_performance_trend
TikTok Ads: Get Daily Performance Trend · read-only · idempotent
Get day-by-day performance trend for the advertiser account (for charts and trend analysis)
| Parameter | Type | Required | Description |
|---|---|---|---|
advertiser_id | string | yes | Advertiser ID. |
start_date | string | yes | Start date (YYYY-MM-DD). |
end_date | string | yes | End date (YYYY-MM-DD). |
data_level | string | no | Level: AUCTION_ADVERTISER, AUCTION_CAMPAIGN (default AUCTION_ADVERTISER). |
tiktok_get_device_models
TikTok Ads: Get Device Models · read-only · idempotent
Get available device models for targeting
| Parameter | Type | Required | Description |
|---|---|---|---|
advertiser_id | string | no | Advertiser ID. |
tiktok_get_diagnostics
TikTok Ads: Get Diagnostics · read-only · idempotent
Get TikTok diagnoses (issues and suggestions) for ad groups, by ad group IDs. TikTok diagnoses ad groups only.
| Parameter | Type | Required | Description |
|---|---|---|---|
advertiser_id | string | no | Advertiser ID. |
object_type | string | no | ADGROUP (the only level TikTok diagnoses). |
object_ids | string[] | no | Ad group IDs to diagnose. |
issue_category | string | no | Optional issue category filter. |
tiktok_get_events
TikTok Ads: Get Events · read-only · idempotent
Get the tracking events of a pixel (same as get_pixel_events)
| Parameter | Type | Required | Description |
|---|---|---|---|
advertiser_id | string | yes | Advertiser ID. |
pixel_code | string | yes | Pixel code. |
tiktok_get_geo_performance
TikTok Ads: Get Geo Performance · read-only · idempotent
Get performance breakdown by country/region
| Parameter | Type | Required | Description |
|---|---|---|---|
advertiser_id | string | yes | Advertiser ID. |
start_date | string | yes | Start date. |
end_date | string | yes | End date. |
tiktok_get_hashtag_suggestions
TikTok Ads: Get Hashtag Suggestions · read-only · idempotent
Get TikTok hashtag suggestions for a keyword.
| Parameter | Type | Required | Description |
|---|---|---|---|
advertiser_id | string | no | Advertiser ID. |
keyword | string | no | Keyword to search. |
tiktok_get_identities
TikTok Ads: Get Identities · read-only · idempotent
Get the identities of a TikTok advertiser, optionally by identity type.
| Parameter | Type | Required | Description |
|---|---|---|---|
advertiser_id | string | no | Advertiser ID. |
identity_type | string | no | Identity type filter. |
tiktok_get_identity_info
TikTok Ads: Get Identity Info · read-only · idempotent
Get detailed information on ONE TikTok identity by identity_id and identity_type (CUSTOMIZED_USER, AUTH_CODE, TT_USER or BC_AUTH_TT).
| Parameter | Type | Required | Description |
|---|---|---|---|
advertiser_id | string | yes | Advertiser ID. |
identity_id | string | yes | Identity ID. |
identity_type | string | yes | Identity type (CUSTOMIZED_USER, AUTH_CODE, TT_USER, BC_AUTH_TT). |
identity_authorized_bc_id | string | no | Business Center ID, required by TikTok when identity_type is BC_AUTH_TT (get_identities returns it). |
tiktok_get_images
TikTok Ads: Get Images · read-only · idempotent
Get images of a TikTok advertiser's library by image IDs (image_ids is required by TikTok).
| Parameter | Type | Required | Description |
|---|---|---|---|
advertiser_id | string | no | Advertiser ID. |
image_ids | string[] | yes | Image IDs (up to 100). |
tiktok_get_interest_keywords
TikTok Ads: Get Interest Keywords · read-only · idempotent
Get TikTok interest keywords recommended for a keyword, optionally in a language.
| Parameter | Type | Required | Description |
|---|---|---|---|
advertiser_id | string | no | Advertiser ID. |
keyword | string | no | Keyword to search. |
language | string | no | Language code. |
tiktok_get_languages
TikTok Ads: Get Languages · read-only · idempotent
Get the languages available for TikTok targeting for an advertiser.
| Parameter | Type | Required | Description |
|---|---|---|---|
advertiser_id | string | no | Advertiser ID. |
tiktok_get_lead_form_details
TikTok Ads: Get Lead Form Details · read-only · idempotent
Get detailed information about a specific lead form
| Parameter | Type | Required | Description |
|---|---|---|---|
advertiser_id | string | yes | Advertiser ID. |
page_id | string | yes | Lead form page ID. |
tiktok_get_lead_form_stats
TikTok Ads: Get Lead Form Stats · read-only · idempotent
Get statistics for lead generation forms (submissions count, conversion rate)
| Parameter | Type | Required | Description |
|---|---|---|---|
advertiser_id | string | yes | Advertiser ID. |
page_ids | string[] | no | Lead form page IDs. |
start_date | string | no | Start date. |
end_date | string | no | End date. |
tiktok_get_lead_forms
TikTok Ads: Get Lead Forms · read-only · idempotent
List the Instant Forms (lead generation forms) of a TikTok advertiser; paginated.
| Parameter | Type | Required | Description |
|---|---|---|---|
advertiser_id | string | yes | Advertiser ID. |
status | string | no | EDITED (draft) or PUBLISHED (ready); all when omitted. |
page | number | no | Page number (default 1). |
page_size | number | no | Page size, 1 to 100 (default 20). |
tiktok_get_lookalike_audiences
TikTok Ads: Get Lookalike Audiences · read-only · idempotent
Get the lookalike audiences of a TikTok advertiser, read from its audience list; paginated (page_size counts all audience types).
| Parameter | Type | Required | Description |
|---|---|---|---|
advertiser_id | string | no | Advertiser ID. |
page | number | no | Page number. |
page_size | number | no | Page size, 1 to 100 (default 100). |
tiktok_get_pixel_code
TikTok Ads: Get Pixel Code · read-only · idempotent
Get the pixel installation code snippet for a website
| Parameter | Type | Required | Description |
|---|---|---|---|
advertiser_id | string | yes | Advertiser ID. |
pixel_id | string | yes | Pixel ID. |
tiktok_get_pixel_events
TikTok Ads: Get Pixel Events · read-only · idempotent
Get the tracking events of a pixel (read from GET /pixel/list/ by pixel code)
| Parameter | Type | Required | Description |
|---|---|---|---|
advertiser_id | string | yes | Advertiser ID. |
pixel_code | string | yes | Pixel code. |
tiktok_get_pixel_overview
TikTok Ads: Get Pixel Overview · read-only · idempotent
Get event statistics of one or more pixels over a period (GET /pixel/event/stats/)
| Parameter | Type | Required | Description |
|---|---|---|---|
advertiser_id | string | yes | Advertiser ID. |
pixel_ids | string[] | yes | Pixel IDs. |
start_date | string | yes | Start date (YYYY-MM-DD). |
end_date | string | yes | End date (YYYY-MM-DD). |
tiktok_get_pixels
TikTok Ads: Get Pixels · read-only · idempotent
Get the pixels of a TikTok advertiser (advertiser_id).
| Parameter | Type | Required | Description |
|---|---|---|---|
advertiser_id | string | no | Advertiser ID. |
tiktok_get_placement_performance
TikTok Ads: Get Placement Performance · read-only · idempotent
Get performance by placement (TikTok, Pangle, News Feed, etc.)
| Parameter | Type | Required | Description |
|---|---|---|---|
advertiser_id | string | yes | Advertiser ID. |
start_date | string | yes | Start date. |
end_date | string | yes | End date. |
tiktok_get_realtime_report
TikTok Ads: Get Realtime Report · read-only · idempotent
Get synchronous performance report (recent data)
| Parameter | Type | Required | Description |
|---|---|---|---|
advertiser_id | string | no | Advertiser ID. |
metrics | string[] | no | Metrics to include. |
dimensions | string[] | no | Dimensions. |
data_level | string | no | Data level (AUCTION_AD, AUCTION_ADGROUP, AUCTION_CAMPAIGN, AUCTION_ADVERTISER). |
tiktok_get_regions
TikTok Ads: Get Regions · read-only · idempotent
Get the regions available for TikTok targeting, by placements and objective type (both required by TikTok).
| Parameter | Type | Required | Description |
|---|---|---|---|
advertiser_id | string | no | Advertiser ID. |
placements | string[] | yes | Placements, e.g. ["PLACEMENT_TIKTOK"]. |
objective_type | string | yes | Objective type, e.g. TRAFFIC, CONVERSIONS, REACH. |
level_range | string | no | Location levels: TO_COUNTRY (default), TO_PROVINCE, TO_CITY, TO_DISTRICT or ALL. ALL lists every district worldwide and does not fit in one answer. |
tiktok_get_smart_suggestions
TikTok Ads: Get Smart Suggestions · read-only · idempotent
Get TikTok recommendations by suggestion type: CREATIVE (Smart Text ad texts for an ad group: adgroup_id), TARGETING (recommended interest and action categories for regions: region_codes), BID (a suggested bid for an objective and locations: objective_type, location_ids).
| Parameter | Type | Required | Description |
|---|---|---|---|
advertiser_id | string | no | Advertiser ID. |
suggestion_type | string | no | CREATIVE, TARGETING or BID. |
adgroup_id | string | no | CREATIVE: ad group ID. |
language | string | no | CREATIVE: EN, JA, RU or VI, with keywords (otherwise TikTok predicts them). |
keywords | string[] | no | CREATIVE: keywords, with language. |
region_codes | string[] | no | TARGETING: country or region codes, e.g. ["FR"]. |
app_id | string | no | TARGETING: optional app ID. |
objective_type | string | no | BID: TRAFFIC or WEB_CONVERSIONS. |
location_ids | string[] | no | BID: location IDs (get_regions). |
campaign_id | string | no | BID: optional campaign ID. |
tiktok_get_spark_ads
TikTok Ads: Get Spark Ads · read-only · idempotent
List authorized TikTok posts that can be used as Spark Ads (organic post boosting)
| Parameter | Type | Required | Description |
|---|---|---|---|
advertiser_id | string | yes | Advertiser ID. |
page | number | no | Page number. |
page_size | number | no | Page size. |
tiktok_get_targeting_tags
TikTok Ads: Get Targeting Tags · read-only · idempotent
Get the internet service providers (ISP) available for TikTok targeting in the given locations.
| Parameter | Type | Required | Description |
|---|---|---|---|
advertiser_id | string | no | Advertiser ID. |
location_ids | string[] | yes | Location IDs (from get_regions), up to 1000. |
scene | string | no | Targeting type: ISP (default). |
tiktok_get_video_info
TikTok Ads: Get Video Info · read-only · idempotent
Get detailed information on TikTok videos of the advertiser's library, by video IDs.
| Parameter | Type | Required | Description |
|---|---|---|---|
advertiser_id | string | no | Advertiser ID. |
video_ids | string[] | yes | Video IDs to get info for (up to 60). |
tiktok_get_video_templates
TikTok Ads: Get Video Templates · read-only · idempotent
Get the catalog video templates (video packages) of a TikTok catalog, by Business Center and catalog. These are the only video templates TikTok API v1.3 still documents.
| Parameter | Type | Required | Description |
|---|---|---|---|
advertiser_id | string | no | Advertiser ID. |
bc_id | string | yes | Business Center ID that owns the catalog (required by TikTok). |
catalog_id | string | yes | Catalog ID (required by TikTok). |
video_package_id | string | no | Optional: one catalog video package ID. |
tiktok_get_videos
TikTok Ads: Get Videos · read-only · idempotent
Get the videos uploaded to a TikTok advertiser's library, optionally by video IDs; paginated.
| Parameter | Type | Required | Description |
|---|---|---|---|
advertiser_id | string | no | Advertiser ID. |
video_ids | string[] | no | Filter by video IDs. |
page | number | no | Page number. |
page_size | number | no | Page size. |
tiktok_list_pixels
TikTok Ads: List Pixels · read-only · idempotent
List existing pixels for an advertiser (same as get_pixels)
| Parameter | Type | Required | Description |
|---|---|---|---|
advertiser_id | string | yes | Advertiser ID. |
tiktok_search_interest_categories
TikTok Ads: Search Interest Categories · read-only · idempotent
Search TikTok interest categories recommended for a keyword.
| Parameter | Type | Required | Description |
|---|---|---|---|
advertiser_id | string | no | Advertiser ID. |
keyword | string | no | Search keyword. |
Create and change (€29)
Served with the €29 plan.
tiktok_authorize_spark_ad
TikTok Ads: Authorize Spark Ad · create or change, €29 plan · creates an object on each call
Authorize a TikTok post for use as a Spark Ad via authorization code
| Parameter | Type | Required | Description |
|---|---|---|---|
advertiser_id | string | yes | Advertiser ID. |
auth_code | string | yes | Authorization code from TikTok creator. |
tiktok_create_ad
TikTok Ads: Create Ad · create or change, €29 plan · creates an object on each call
Create a new TikTok ad in adgroup_id: format, text, image or video, call to action, landing page URL and identity.
| Parameter | Type | Required | Description |
|---|---|---|---|
advertiser_id | string | no | Advertiser ID. |
adgroup_id | string | no | Ad group ID. |
ad_name | string | no | Ad name. |
ad_format | string | no | Ad format (SINGLE_IMAGE, SINGLE_VIDEO, CAROUSEL). |
ad_text | string | no | Ad text/caption. |
image_ids | string[] | no | Image IDs for the ad. |
video_id | string | no | Video ID for video ads. |
call_to_action | string | no | Call to action button text. |
landing_page_url | string | no | Landing page URL. |
display_name | string | no | Display name. |
identity_id | string | no | Identity ID for the ad. |
identity_type | string | no | Identity type (CUSTOMIZED_USER, AUTH_CODE, TT_USER). |
operation_status | string | no | Initial status. |
tiktok_create_ad_group
TikTok Ads: Create Ad Group · create or change, €29 plan · creates an object on each call
Create a new TikTok ad group in campaign_id: placements, locations, budget, schedule, optimization goal, billing event, bid and audience.
| Parameter | Type | Required | Description |
|---|---|---|---|
advertiser_id | string | no | Advertiser ID. |
campaign_id | string | no | Campaign ID. |
adgroup_name | string | no | Ad group name. |
promotion_type | string | no | Promotion type, required by TikTok. WEBSITE for an ad group that sends people to a website; see the TikTok Marketing API for the other values (apps, lead generation, shop). |
placement_type | string | no | Placement type (PLACEMENT_TYPE_AUTOMATIC, PLACEMENT_TYPE_NORMAL). |
placements | string[] | no | Placements if not automatic. |
location_ids | string[] | no | Target location IDs. |
budget_mode | string | no | Budget mode. |
budget | number | no | Budget amount. |
schedule_type | string | no | Schedule type (SCHEDULE_FROM_NOW, SCHEDULE_START_END). |
schedule_start_time | string | no | Start time (YYYY-MM-DD HH:mm:ss). |
schedule_end_time | string | no | End time (YYYY-MM-DD HH:mm:ss). |
optimization_goal | string | no | Optimization goal (CLICK, CONVERT, REACH, etc.). |
billing_event | string | no | Billing event (CPC, CPM, OCPM, CPV). |
bid_type | string | no | Bid type (BID_TYPE_NO_BID, BID_TYPE_CUSTOM). |
bid | number | no | Bid amount. |
gender | string | no | Target gender (GENDER_UNLIMITED, GENDER_MALE, GENDER_FEMALE). |
age_groups | string[] | no | Target age groups. |
operation_status | string | no | Initial status. |
tiktok_create_automation_rule
TikTok Ads: Create Automation Rule · create or change, €29 plan · creates an object on each call
Create an automated rule (auto-pause when CPA too high, increase budget when performing well, etc.). Pass the whole rule: name, conditions, actions, apply_objects, notification, rule_exec_info. Returns rule_ids. Read it with get_automation_rule, change it with update_automation_rule, delete it with delete_automation_rule.
| Parameter | Type | Required | Description |
|---|---|---|---|
advertiser_id | string | yes | Advertiser ID. |
name | string | yes | Rule name. |
conditions | any[] | yes | Conditions: [{ subject_type, range_type, calculation_type, match_type, values }]. |
actions | any[] | yes | Actions: [{ subject_type, action_type, value_type, value, frequency_info }]. |
apply_objects | any[] | yes | Objects the rule applies to: [{ dimension, dimension_ids, pre_condition_type, bind_type }]. |
notification | object | yes | Notification: { notification_type, email_setting }. |
rule_exec_info | object | yes | Execution: { exec_time_type, exec_time, time_period_info }. |
tzone | string | no | Time zone of the rule. |
tiktok_create_campaign
TikTok Ads: Create Campaign · create or change, €29 plan · creates an object on each call
Create a new TikTok campaign for an advertiser: name, objective type, budget mode and budget, optional initial status.
| Parameter | Type | Required | Description |
|---|---|---|---|
advertiser_id | string | no | Advertiser ID. |
campaign_name | string | no | Campaign name. |
objective_type | string | no | Objective type (REACH, TRAFFIC, VIDEO_VIEWS, LEAD_GENERATION, ENGAGEMENT, APP_PROMOTION, WEB_CONVERSIONS, CATALOG_SALES). |
budget_mode | string | no | Budget mode (BUDGET_MODE_INFINITE, BUDGET_MODE_DAY, BUDGET_MODE_TOTAL). |
budget | number | no | Budget amount (required if budget_mode is not INFINITE). |
operation_status | string | no | Initial status (ENABLE, DISABLE). |
tiktok_create_conversion_event
TikTok Ads: Create Conversion Event · create or change, €29 plan · creates an object on each call
Create a custom conversion event on a pixel for tracking specific actions (POST /pixel/event/create/). Rename it with update_pixel_event, delete it with delete_pixel_event.
| Parameter | Type | Required | Description |
|---|---|---|---|
advertiser_id | string | yes | Advertiser ID. |
pixel_id | string | yes | Pixel ID. |
event_name | string | yes | Event name (CompletePayment, SubmitForm, Contact, Subscribe, etc.). |
event_type | string | no | Event type. |
tiktok_create_custom_audience
TikTok Ads: Create Custom Audience · create or change, €29 plan · creates an object on each call
Create a TikTok custom audience from customer files already uploaded to TikTok (file_paths) and their encryption type (calculate_type); optional sub-type and retention in days.
| Parameter | Type | Required | Description |
|---|---|---|---|
advertiser_id | string | no | Advertiser ID. |
custom_audience_name | string | yes | Audience name (at most 128 characters). |
file_paths | string[] | yes | File paths returned by TikTok when the customer files were uploaded. |
calculate_type | string | yes | Encryption type of the files, e.g. EMAIL_SHA256, PHONE_SHA256, IDFA_SHA256, GAID_SHA256. |
audience_sub_type | string | no | Audience sub-type: NORMAL or REACH_FREQUENCY. |
retention_in_days | number | no | Days to retain the audience, 1 to 365. |
retention_days | number | no | Alias of retention_in_days. |
tiktok_create_custom_audience_rules
TikTok Ads: Create Custom Audience Rules · create or change, €29 plan · creates an object on each call
Create a TikTok audience by rule (website visitors, app activity, engagement...): audience_type and rule_spec { inclusion_rule_set, exclusion_rule_set } are required by TikTok. Returns custom_audience_id. Rename it with update_custom_audience, delete it with delete_custom_audience.
| Parameter | Type | Required | Description |
|---|---|---|---|
advertiser_id | string | yes | Advertiser ID. |
custom_audience_name | string | yes | Audience name (at most 128 characters). |
audience_type | string | yes | ENGAGEMENT, ENGAGEMENT_ORGANIC_VIDEO, ENGAGEMENT_LIVE_VIDEO, APP, PIXEL, LEAD_GENERATION, BUSINESS_ACCOUNT, TIKTOK_SHOP or OFFLINE. |
rule_spec | object | yes | Rule of the audience: { inclusion_rule_set, exclusion_rule_set }. |
retention_in_days | number | no | Days to retain the audience, 1 to 365. |
retention_days | number | no | Alias of retention_in_days. |
is_auto_refresh | boolean | no | Refresh the audience daily (TikTok default: true). |
tiktok_create_event
TikTok Ads: Create Event · create or change, €29 plan · creates an object on each call
Create a tracking event on a pixel designated by its code (POST /pixel/event/create/). Rename it with update_pixel_event, delete it with delete_pixel_event.
| Parameter | Type | Required | Description |
|---|---|---|---|
advertiser_id | string | yes | Advertiser ID. |
pixel_code | string | yes | Pixel code. |
event_name | string | yes | Event name. |
event_type | string | no | Event type. |
tiktok_create_identity
TikTok Ads: Create Identity · create or change, €29 plan · creates an object on each call
Create a new custom TikTok identity (CUSTOMIZED_USER) for an advertiser, with a display name and an image (image_uri). Returns identity_id. TikTok cannot edit an identity: to change it, delete it with delete_identity and create a new one.
| Parameter | Type | Required | Description |
|---|---|---|---|
advertiser_id | string | no | Advertiser ID. |
display_name | string | no | Display name for the identity. |
image_uri | string | no | Profile image URI. |
tiktok_create_lookalike_audience
TikTok Ads: Create Lookalike Audience · create or change, €29 plan · creates an object on each call
Create a TikTok lookalike audience from a source audience (custom_audience_id, at least 100 people, not itself a lookalike). lookalike_spec: { include_source, mobile_os (ALL, ANDROID, IOS), placements, location_ids, audience_size }. Returns custom_audience_id. Rename it with update_custom_audience, delete it with delete_custom_audience.
| Parameter | Type | Required | Description |
|---|---|---|---|
advertiser_id | string | yes | Advertiser ID. |
lookalike_name | string | yes | Lookalike audience name (at most 128 characters). |
custom_audience_id | string | yes | Source (seed) audience ID. |
lookalike_spec | object | yes | Lookalike specification: { include_source, mobile_os, placements, location_ids, audience_size }. |
tiktok_create_pixel
TikTok Ads: Create Pixel · create or change, €29 plan · creates an object on each call
Create a new TikTok pixel named pixel_name for an advertiser. Returns pixel_id and pixel_code. Rename it with update_pixel. TikTok has no endpoint to delete a pixel (the v1.3 Pixel Events reference lists get, create and update only): create one only if it must stay.
| Parameter | Type | Required | Description |
|---|---|---|---|
advertiser_id | string | no | Advertiser ID. |
pixel_name | string | no | Pixel name. |
tiktok_duplicate_campaign
TikTok Ads: Duplicate Campaign · create or change, €29 plan · creates an object on each call
Copy an existing campaign's settings (name, objective, budget) into a new PAUSED campaign. Its ad groups and ads are NOT copied: TikTok has no deep copy. Returns new_campaign_id; delete the copy with delete_campaign.
| Parameter | Type | Required | Description |
|---|---|---|---|
advertiser_id | string | yes | Advertiser ID. |
campaign_id | string | yes | Campaign ID to duplicate. |
copy_name | string | no | Name for the copy. |
tiktok_generate_video_from_images
TikTok Ads: Generate Video from Images · create or change, €29 plan · creates an object on each call
Start a Smart Video task from images (POST /creative/smart_video/create/). TikTok marks this endpoint deprecated in its v1.3 reference: it returns a task, not a video; the resulting video, once in the library, is deleted with delete_video.
| Parameter | Type | Required | Description |
|---|---|---|---|
advertiser_id | string | no | Advertiser ID. |
image_ids | string[] | no | Image IDs to use. |
video_template_id | string | no | Video template ID. |
tiktok_hide_comment
TikTok Ads: Hide Comment · create or change, €29 plan · creates an object on each call
Hide a comment on a TikTok ad by comment_id.
| Parameter | Type | Required | Description |
|---|---|---|---|
advertiser_id | string | no | Advertiser ID. |
comment_id | string | no | Comment ID to hide. |
tiktok_manage_pixel_events
TikTok Ads: Manage Pixel Events · create or change, €29 plan · creates an object on each call
Create a tracking event on a pixel (POST /pixel/event/create/). Rename it with update_pixel_event, delete it with delete_pixel_event.
| Parameter | Type | Required | Description |
|---|---|---|---|
advertiser_id | string | yes | Advertiser ID. |
pixel_id | string | yes | Pixel ID. |
event_name | string | yes | Event name (e.g. CompletePayment, ViewContent). |
event_type | string | no | Event type (e.g. CLICK, URL). |
statistic_type | string | no | Counting method (e.g. EVERY_TIME, ONCE). |
currency | string | no | Currency of the event value. |
currency_value | string | no | Value of the event. |
tiktok_reply_comment
TikTok Ads: Reply Comment · create or change, €29 plan · creates an object on each call
Reply with a text to a comment on a TikTok ad (comment_id).
| Parameter | Type | Required | Description |
|---|---|---|---|
advertiser_id | string | no | Advertiser ID. |
comment_id | string | no | Comment ID to reply to. |
text | string | no | Reply text. |
tiktok_unshare_custom_audience
TikTok Ads: Unshare Custom Audience · create or change, €29 plan · creates an object on each call
Stop sharing ONE TikTok audience (custom_audience_id) with ONE advertiser (shared_advertiser_id). The reverse of share_custom_audience.
| Parameter | Type | Required | Description |
|---|---|---|---|
advertiser_id | string | yes | Advertiser ID (owner of the audience). |
custom_audience_id | string | yes | Audience to stop sharing. |
shared_advertiser_id | string | yes | Advertiser to stop sharing it with. |
tiktok_update_ad
TikTok Ads: Update Ad · create or change, €29 plan · creates an object on each call
Update an existing TikTok ad by ad_id: its name, text, call to action or landing page URL.
| Parameter | Type | Required | Description |
|---|---|---|---|
advertiser_id | string | no | Advertiser ID. |
ad_id | string | no | Ad ID. |
ad_name | string | no | New ad name. |
ad_text | string | no | New ad text. |
call_to_action | string | no | New call to action. |
landing_page_url | string | no | New landing page URL. |
tiktok_update_ad_group
TikTok Ads: Update Ad Group · create or change, €29 plan · creates an object on each call
Update an existing TikTok ad group by adgroup_id: its name, budget, schedule end time or bid.
| Parameter | Type | Required | Description |
|---|---|---|---|
advertiser_id | string | no | Advertiser ID. |
adgroup_id | string | no | Ad group ID. |
adgroup_name | string | no | New ad group name. |
budget | number | no | New budget. |
schedule_end_time | string | no | New end time. |
bid | number | no | New bid amount. |
tiktok_update_ad_group_status
TikTok Ads: Update Ad Group Status · create or change, €29 plan · creates an object on each call
Update ad group status (enable/disable/delete)
| Parameter | Type | Required | Description |
|---|---|---|---|
advertiser_id | string | no | Advertiser ID. |
adgroup_ids | string[] | no | Ad group IDs to update. |
operation_status | string | no | New status (ENABLE, DISABLE, DELETE). |
tiktok_update_ad_status
TikTok Ads: Update Ad Status · create or change, €29 plan · creates an object on each call
Update ad status (enable/disable/delete)
| Parameter | Type | Required | Description |
|---|---|---|---|
advertiser_id | string | no | Advertiser ID. |
ad_ids | string[] | no | Ad IDs to update. |
operation_status | string | no | New status (ENABLE, DISABLE, DELETE). |
tiktok_update_adgroup_budget
TikTok Ads: Update Ad Group Budget · create or change, €29 plan · creates an object on each call
Update the budget of a TikTok ad group (adgroup_id) to a new amount.
| Parameter | Type | Required | Description |
|---|---|---|---|
advertiser_id | string | yes | Advertiser ID. |
adgroup_id | string | yes | Ad Group ID. |
budget | number | yes | New budget amount. |
tiktok_update_adgroup_schedule
TikTok Ads: Update Ad Group Schedule · create or change, €29 plan · creates an object on each call
Update the schedule (start/end dates) of an ad group
| Parameter | Type | Required | Description |
|---|---|---|---|
advertiser_id | string | yes | Advertiser ID. |
adgroup_id | string | yes | Ad Group ID. |
schedule_start_time | string | no | Start time (YYYY-MM-DD HH:MM:SS). |
schedule_end_time | string | no | End time (YYYY-MM-DD HH:MM:SS). |
tiktok_update_automation_rule
TikTok Ads: Update Automation Rule · create or change, €29 plan · creates an object on each call
Update ONE automated rule. TikTok replaces the whole rule: pass every field (read it first with get_automation_rule and send it back modified).
| Parameter | Type | Required | Description |
|---|---|---|---|
advertiser_id | string | yes | Advertiser ID. |
rule_id | string | yes | Rule ID. |
name | string | yes | Rule name. |
conditions | any[] | yes | Conditions: [{ subject_type, range_type, calculation_type, match_type, values }]. |
actions | any[] | yes | Actions: [{ subject_type, action_type, value_type, value, frequency_info }]. |
apply_objects | any[] | yes | Objects the rule applies to: [{ dimension, dimension_ids, pre_condition_type, bind_type }]. |
notification | object | yes | Notification: { notification_type, email_setting }. |
rule_exec_info | object | yes | Execution: { exec_time_type, exec_time, time_period_info }. |
tzone | string | no | Time zone of the rule. |
tiktok_update_campaign
TikTok Ads: Update Campaign · create or change, €29 plan · creates an object on each call
Update an existing TikTok campaign by campaign_id: its name, budget mode or budget.
| Parameter | Type | Required | Description |
|---|---|---|---|
advertiser_id | string | no | Advertiser ID. |
campaign_id | string | no | Campaign ID. |
campaign_name | string | no | New campaign name. |
budget_mode | string | no | Budget mode. |
budget | number | no | Budget amount. |
tiktok_update_campaign_budget
TikTok Ads: Update Campaign Budget · create or change, €29 plan · creates an object on each call
Update the budget of a campaign (daily or total)
| Parameter | Type | Required | Description |
|---|---|---|---|
advertiser_id | string | yes | Advertiser ID. |
campaign_id | string | yes | Campaign ID. |
budget | number | yes | New budget amount in local currency. |
budget_mode | string | no | BUDGET_MODE_DAY or BUDGET_MODE_TOTAL. |
tiktok_update_campaign_status
TikTok Ads: Update Campaign Status · create or change, €29 plan · creates an object on each call
Update campaign status (enable/disable/delete)
| Parameter | Type | Required | Description |
|---|---|---|---|
advertiser_id | string | no | Advertiser ID. |
campaign_ids | string[] | no | Campaign IDs to update. |
operation_status | string | no | New status (ENABLE, DISABLE, DELETE). |
tiktok_update_custom_audience
TikTok Ads: Update Custom Audience · create or change, €29 plan · creates an object on each call
Rename a TikTok custom audience (custom_audience_id, custom_audience_name).
| Parameter | Type | Required | Description |
|---|---|---|---|
advertiser_id | string | no | Advertiser ID. |
custom_audience_id | string | no | Audience ID. |
custom_audience_name | string | no | New audience name. |
tiktok_update_image_name
TikTok Ads: Update Image Name · create or change, €29 plan · creates an object on each call
Rename ONE image of a TikTok advertiser's creative library (image_id, file_name of 1 to 100 characters). The image itself cannot be changed: upload a new one.
| Parameter | Type | Required | Description |
|---|---|---|---|
advertiser_id | string | yes | Advertiser ID. |
image_id | string | yes | Image ID. |
file_name | string | yes | New image name, 1 to 100 characters. |
tiktok_update_pixel
TikTok Ads: Update Pixel · create or change, €29 plan · creates an object on each call
Rename ONE TikTok pixel (pixel_id, or pixel_code if the ID is unknown; pixel_name of at most 40 characters).
| Parameter | Type | Required | Description |
|---|---|---|---|
advertiser_id | string | yes | Advertiser ID. |
pixel_id | string | no | Pixel ID (preferred). |
pixel_code | string | no | Pixel code, used to find the pixel ID when pixel_id is not given. |
pixel_name | string | yes | New pixel name, at most 40 characters. |
tiktok_update_pixel_event
TikTok Ads: Update Pixel Event · create or change, €29 plan · creates an object on each call
Update ONE pixel event by its ID: its name (required by TikTok, at most 40 characters) and optionally its value and currency.
| Parameter | Type | Required | Description |
|---|---|---|---|
advertiser_id | string | yes | Advertiser ID. |
event_id | string | yes | ID of the pixel event to update. |
pixel_id | string | yes | ID of the pixel that owns the event (read before and after the update; not sent to TikTok). |
event_name | string | yes | Event name, at most 40 characters (send the current name to keep it). |
currency | string | no | Currency of the event value. |
currency_value | string | no | Value of the event. |
tiktok_update_video_name
TikTok Ads: Update Video Name · create or change, €29 plan · creates an object on each call
Rename ONE video of a TikTok advertiser's creative library (video_id, file_name of 1 to 100 characters). The video itself cannot be changed: upload a new one.
| Parameter | Type | Required | Description |
|---|---|---|---|
advertiser_id | string | yes | Advertiser ID. |
video_id | string | yes | Video ID. |
file_name | string | yes | New video name, 1 to 100 characters. |
tiktok_upload_image
TikTok Ads: Upload Image · create or change, €29 plan · creates an object on each call
Upload an image from URL for ad creatives
| Parameter | Type | Required | Description |
|---|---|---|---|
advertiser_id | string | yes | Advertiser ID. |
image_url | string | yes | URL of the image to upload. |
file_name | string | no | File name for the image. |
tiktok_upload_image_by_url
TikTok Ads: Upload Image by URL · create or change, €29 plan · creates an object on each call
Upload an image to a TikTok advertiser's library from a URL, with an optional file name. Returns image_id. Rename it with update_image_name, delete it with delete_image.
| Parameter | Type | Required | Description |
|---|---|---|---|
advertiser_id | string | no | Advertiser ID. |
image_url | string | no | URL of the image to upload. |
file_name | string | no | File name for the image. |
tiktok_upload_video
TikTok Ads: Upload Video · create or change, €29 plan · creates an object on each call
Upload a video from URL for ad creatives
| Parameter | Type | Required | Description |
|---|---|---|---|
advertiser_id | string | yes | Advertiser ID. |
video_url | string | yes | URL of the video to upload. |
file_name | string | no | File name for the video. |
tiktok_upload_video_by_url
TikTok Ads: Upload Video by URL · create or change, €29 plan · creates an object on each call
Upload a video to a TikTok advertiser's library from a URL, with an optional file name. Returns video_id. Rename it with update_video_name, delete it with delete_video.
| Parameter | Type | Required | Description |
|---|---|---|---|
advertiser_id | string | no | Advertiser ID. |
video_url | string | no | URL of the video to upload. |
file_name | string | no | File name for the video. |
Delete (€29)
Served with the €29 plan. A deletion targets one object at a time.
tiktok_bulk_update_ad_status
TikTok Ads: Bulk Update Ad Status · delete, €29 plan, one object at a time · creates an object on each call
Batch update statuses for multiple ads at once
| Parameter | Type | Required | Description |
|---|---|---|---|
advertiser_id | string | yes | Advertiser ID. |
ad_ids | string[] | yes | Ad IDs to update. |
opt_status | string | yes | New status: ENABLE, DISABLE, or DELETE. |
tiktok_bulk_update_adgroup_status
TikTok Ads: Bulk Update Ad Group Status · delete, €29 plan, one object at a time · creates an object on each call
Batch update statuses for multiple ad groups at once
| Parameter | Type | Required | Description |
|---|---|---|---|
advertiser_id | string | yes | Advertiser ID. |
adgroup_ids | string[] | yes | Ad group IDs to update. |
opt_status | string | yes | New status: ENABLE, DISABLE, or DELETE. |
tiktok_bulk_update_campaign_status
TikTok Ads: Bulk Update Campaign Status · delete, €29 plan, one object at a time · creates an object on each call
Batch update statuses for multiple campaigns at once
| Parameter | Type | Required | Description |
|---|---|---|---|
advertiser_id | string | yes | Advertiser ID. |
campaign_ids | string[] | yes | Campaign IDs to update. |
opt_status | string | yes | New status: ENABLE, DISABLE, or DELETE. |
tiktok_delete_ad
TikTok Ads: Delete Ad · delete, €29 plan, one object at a time · creates an object on each call
Delete ONE ad by its ID (irreversible: TikTok operation_status DELETE). To pause it instead, use the status tool with DISABLE.
| Parameter | Type | Required | Description |
|---|---|---|---|
advertiser_id | string | yes | Advertiser ID. |
ad_id | string | yes | ID of the ad to delete (one only). |
tiktok_delete_ad_group
TikTok Ads: Delete Ad Group · delete, €29 plan, one object at a time · creates an object on each call
Delete ONE ad group by its ID (irreversible: TikTok operation_status DELETE). To pause it instead, use the status tool with DISABLE.
| Parameter | Type | Required | Description |
|---|---|---|---|
advertiser_id | string | yes | Advertiser ID. |
adgroup_id | string | yes | ID of the ad group to delete (one only). |
tiktok_delete_automation_rule
TikTok Ads: Delete Automation Rule · delete, €29 plan, one object at a time · creates an object on each call
Delete ONE automated rule by its ID (irreversible).
| Parameter | Type | Required | Description |
|---|---|---|---|
advertiser_id | string | yes | Advertiser ID. |
rule_id | string | yes | ID of the rule to delete (one only). |
tiktok_delete_campaign
TikTok Ads: Delete Campaign · delete, €29 plan, one object at a time · creates an object on each call
Delete ONE campaign by its ID (irreversible: TikTok operation_status DELETE). To pause it instead, use the status tool with DISABLE.
| Parameter | Type | Required | Description |
|---|---|---|---|
advertiser_id | string | yes | Advertiser ID. |
campaign_id | string | yes | ID of the campaign to delete (one only). |
tiktok_delete_comment
TikTok Ads: Delete Comment · delete, €29 plan, one object at a time · creates an object on each call
Delete a comment on a TikTok ad by comment_id.
| Parameter | Type | Required | Description |
|---|---|---|---|
advertiser_id | string | no | Advertiser ID. |
comment_id | string | no | Comment ID to delete. |
tiktok_delete_custom_audience
TikTok Ads: Delete Custom Audience · delete, €29 plan, one object at a time · creates an object on each call
Delete ONE TikTok audience by custom_audience_id (irreversible): a customer file audience, an audience created by rule, or a lookalike audience.
| Parameter | Type | Required | Description |
|---|---|---|---|
advertiser_id | string | yes | Advertiser ID. |
custom_audience_id | string | yes | ID of the audience to delete (one only). |
tiktok_delete_identity
TikTok Ads: Delete Identity · delete, €29 plan, one object at a time · creates an object on each call
Delete ONE custom TikTok identity (identity_type CUSTOMIZED_USER, the only type TikTok lets delete) by identity_id (irreversible).
| Parameter | Type | Required | Description |
|---|---|---|---|
advertiser_id | string | yes | Advertiser ID. |
identity_id | string | yes | ID of the identity to delete (one only). |
identity_type | string | no | Identity type: CUSTOMIZED_USER only (always sent as CUSTOMIZED_USER). |
tiktok_delete_image
TikTok Ads: Delete Image · delete, €29 plan, one object at a time · creates an object on each call
Delete ONE image from a TikTok advertiser's creative library by image_id (irreversible).
| Parameter | Type | Required | Description |
|---|---|---|---|
advertiser_id | string | yes | Advertiser ID. |
image_id | string | yes | ID of the image to delete (one only). |
tiktok_delete_pixel_event
TikTok Ads: Delete Pixel Event · delete, €29 plan, one object at a time · creates an object on each call
Delete ONE pixel event by its ID (irreversible). TikTok does not allow deleting a pixel itself.
| Parameter | Type | Required | Description |
|---|---|---|---|
advertiser_id | string | yes | Advertiser ID. |
event_id | string | yes | ID of the pixel event to delete (one only). |
pixel_id | string | yes | ID of the pixel that owns the event (read before and after the deletion; not sent to TikTok). |
tiktok_delete_video
TikTok Ads: Delete Video · delete, €29 plan, one object at a time · creates an object on each call
Delete ONE video from a TikTok advertiser's creative library by video_id (irreversible).
| Parameter | Type | Required | Description |
|---|---|---|---|
advertiser_id | string | yes | Advertiser ID. |
video_id | string | yes | ID of the video to delete (one only). |