Update an ad group — TikTok Business API

Update an ad group

Request

Endpoint

Authentication & shop

Request parameters

Request examples

curl -s -X POST "https://partner.quantri360.com/v1/tiktok_business/adgroup/update/" \
  -H "Authorization: Bearer $KEY" \
  -H "Content-Type: application/json" \
  -d '{"adgroup_id":"","search_keywords":[{}],"included_custom_actions":[{}],"excluded_custom_actions":[{}],"actions":[{}],"targeting_expansion":{}}'

import requests

KEY = "q360_live_..."  # khóa API của brand
r = requests.post(
    "https://partner.quantri360.com/v1/tiktok_business/adgroup/update/",
    params={},
    json={
        "adgroup_id": "",
        "search_keywords": [
            {}
        ],
        "included_custom_actions": [
            {}
        ],
        "excluded_custom_actions": [
            {}
        ],
        "actions": [
            {}
        ],
        "targeting_expansion": {}
    },
    headers={"Authorization": f"Bearer {KEY}"},
    timeout=60,
)
print(r.status_code)
print(r.json())

const KEY = 'q360_live_...'; // khóa API của brand
const url = new URL('https://partner.quantri360.com/v1/tiktok_business/adgroup/update/');
for (const [k, v] of Object.entries({})) url.searchParams.set(k, typeof v === 'object' ? JSON.stringify(v) : String(v));
const r = await fetch(url, {
  method: 'POST',
  headers: { Authorization: `Bearer ${KEY}`, 'Content-Type': 'application/json' },
  body: JSON.stringify({"adgroup_id":"","search_keywords":[{}],"included_custom_actions":[{}],"excluded_custom_actions":[{}],"actions":[{}],"targeting_expansion":{}}),
});
console.log(r.status, await r.json());

<?php
$key = 'q360_live_...'; // khóa API của brand
$url = 'https://partner.quantri360.com/v1/tiktok_business/adgroup/update/' . '?' . http_build_query([]);
$ch = curl_init($url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, ['Authorization: Bearer ' . $key, 'Content-Type: application/json']);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{"adgroup_id":"","search_keywords":[{}],"included_custom_actions":[{}],"excluded_custom_actions":[{}],"actions":[{}],"targeting_expansion":{}}');
$res = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);
echo $status, "\n", $res;

Response

Response fields (as returned by TikTok Business)

Response sample

HTTPS/1.1 200 OK
{
    "code": 0,
    "message": "OK",
    "request_id": "{{request_id}}",
    "data": {
        "purchased_reach": null,
        "budget_mode": "BUDGET_MODE_TOTAL",
        "conversion_bid_price": 0,
        "adgroup_app_profile_page_state": null,
        "search_result_enabled": false,
        "create_time": "{{create_time}}",
        "rf_purchased_type": null,
        "comment_disabled": false,
        "category_id": "0",
        "statistic_type": null,
        "brand_safety_type": "NO_BRAND_SAFETY",
        "promotion_type": "WEBSITE",
        "modify_time": "{{modify_time}}",
        "pixel_id": null,
        "secondary_status": "ADGROUP_STATUS_CREATE",
        "is_hfss": false,
        "excluded_audience_ids": [],
        "actions": [],
        "gender": "GENDER_UNLIMITED",
        "adgroup_name": "{{adgroup_name}}",
        "adgroup_id": "{{adgroup_id}}",
        "app_download_url": null,
        "optimization_goal": "CLICK",
        "frequency": null,
        "deep_cpa_bid": 0,
        "inventory_filter_enabled": false,
        "audience_ids": [],
        "auto_targeting_enabled": false,
        "deep_bid_type": null,
        "brand_safety_partner": null,
        "campaign_name": "{{campaign_name}}",
        "operating_systems": [
            "ANDROID"
        ],
        "network_types": [],
        "is_new_structure": true,
        "scheduled_budget": 0,
        "schedule_end_time": "{{schedule_end_time}}",
        "placement_type": "PLACEMENT_TYPE_NORMAL",
        "video_download_disabled": false,
        "app_type": null,
        "category_exclusion_ids": [],
        "age_groups": null,
        "location_ids": [
            "{{location_id}}"
        ],
        "placements": [
            "PLACEMENT_TIKTOK"
        ],
        "optimization_event": null,
        "interest_keyword_ids": [],
        "campaign_id": "{{campaign_id}}",
        "bid_price": 0,
        "dayparting": "111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111",
        "ios14_quota_type": "UNOCCUPIED",
        "delivery_mode": null,
        "secondary_optimization_event": null,
        "app_id": null,
        "creative_material_mode": "CUSTOM",
        "share_disabled": false,
        "purchased_impression": null,
        "rf_estimated_frequency": null,
        "operation_status": "ENABLE",
        "next_day_retention": null,
        "schedule_type": "SCHEDULE_START_END",
        "frequency_schedule": null,
        "schedule_infos": null,
        "keywords": null,
        "bid_type": "BID_TYPE_NO_BID",
        "bid_display_mode": "CPMV",
        "skip_learning_phase": false,
        "billing_event": "CPC",
        "interest_category_ids": [],
        "rf_estimated_cpr": null,
        "isp_ids": [],
        "pacing": "PACING_MODE_SMOOTH",
        "feed_type": null,
        "schedule_start_time": "{{schedule_start_time}}",
        "languages": [],
        "conversion_window": null,
        "budget": {{budget}},
        "advertiser_id": "{{advertiser_id}}",
        "device_price_ranges": null,
        "need_audit": false
    }
}

Get started

1. Sign up for Partner
2. Enable a data type of the Ads (Marketing API) group on the platform page
3. Create an API key (tick the TikTok Business channel)
4. Call it as in the examples above