VI | EN
Message us on Messenger
Developer resources

Update a campaign — TikTok Business API

Update a campaign · call it through Quantri360 with one API key for your own accounts / assets that you connected and authorized — 360 handles request signing and refreshing the authorization you granted.

Update a campaign

POST/campaign/update/Via 360: POST https://partner.quantri360.com/v1/tiktok_business/campaign/update/
Write endpoint — changes data on TikTok Business. The key must be created with "Allow write API calls" ticked, otherwise you get 403 write_not_allowed. Every call is logged.
Description

Use this endpoint to modify a campaign after it has been created.

Request

Endpoint

POST https://partner.quantri360.com/v1/tiktok_business/campaign/update/

Authentication & shop

NameInTypeSampleDescription
AuthorizationheaderheaderBearer q360_live_ab12cd34_…Khóa API của brand (tạo ở mục API key). Bắt buộc với mọi request. Brand suy từ key — không truyền mã brand.
platform_shop_idquerystring7000000000000000001Tài sản TikTok Business đã kết nối — "Mã tài sản" ở trang Nền tảng hoặc GET /v1/platforms (tài khoản quảng cáo cho Marketing API, tài khoản TikTok cho Organic / Messaging). Có thể bỏ khi chỉ kết nối một tài sản.

Request parameters

NameInTypeRequiredSampleDescription
campaign_idbodystringYesCampaign ID
campaign_namebodystringNoCampaign name. Length limit: 512 characters. Emoji is not supported. Each word in Chinese or Japanese counts as two characters, while each letter in English counts as one character.
special_industriesbodystring[]NoSpecial ad categories. By selecting a housing, employment, or credit category for your campaign, you certify not to use TikTok to discriminate based on protected characteristics in ads relating to housing, employment, or credit and to adhere to TikTok's special ad category policy. Once you use this field to indicate that your campaign is promoting opportunities in any of the ad categories, the targeting options at the ad group level will be limited to help you comply with anti-discrimination laws in these categories. See Targeting requirements for ad groups in a campaign with special ad categories to learn about the requirements. Enum values: - HOUSING: Ads for real estate listings, homeowners insurance, mortgage loans or other related opportunities. - EMPLOYMENT: Ads for job offers, internship, professional certification programs or other related opportunities. - CREDIT: Ads for credit card offers, auto loans, long-term financing or other related opportunities. Note: - Using special ad categories in Shopping Ads with campaign product source as Catalog and in Shopping Ads with campaign product source as non-Catalog are currently separate allowlist-only features. If you would like to access them, please contact your TikTok representative. - This field is generally available to advertisers registered in America or Canada. Advertisers who are not registered in America or Canada but want to target these countries with special ad categories need to apply for an additional allowlist. - If you have selected special ad categories for a campaign, you can remove the special ad categories, but you cannot change them or enable the special ad categories for an existing campaign if the special ad categories are currently disabled.
budgetbodyfloatNoCampaign budget. To learn about the minimum budget and how to set budget modes, see Budget. To directly see the daily budget value range for a currency, see Currency-Daily budget value range. Note: The new budget should be at least 105% of the current spend. You can run a synchronous report or an asynchronous report to get the spend data via the Basic data metric spend .
po_numberbodystringNoPO (purchase order) number. PO numbers are useful for invoice tracking and reconciliation. Learn more about PO numbers on monthly invoices.

Request examples

curl -s -X POST "https://partner.quantri360.com/v1/tiktok_business/campaign/update/" \
  -H "Authorization: Bearer $KEY" \
  -H "Content-Type: application/json" \
  -d '{"campaign_id":""}'
Python
import requests

KEY = "q360_live_..."  # khóa API của brand
r = requests.post(
    "https://partner.quantri360.com/v1/tiktok_business/campaign/update/",
    params={},
    json={
        "campaign_id": ""
    },
    headers={"Authorization": f"Bearer {KEY}"},
    timeout=60,
)
print(r.status_code)
print(r.json())
Node.js
const KEY = 'q360_live_...'; // khóa API của brand
const url = new URL('https://partner.quantri360.com/v1/tiktok_business/campaign/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({"campaign_id":""}),
});
console.log(r.status, await r.json());
PHP
<?php
$key = 'q360_live_...'; // khóa API của brand
$url = 'https://partner.quantri360.com/v1/tiktok_business/campaign/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, '{"campaign_id":""}');
$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)

NameTypeSampleDescription
codenumberThe response code. For the complete list of response codes and descriptions, see Appendix - Return Codes.
messagestringThe response message. For details, see Appendix - Return Codes.
request_idstringThe log id of a request, which uniquely identifies the request.
dataobjectReturned data.
advertiser_idstringAdvertiser ID.
campaign_idstringCampaign ID.
create_timestringTime at which the campaign was created.
modify_timestringTime at which the campaign was Modified.
objective_typestringAdvertising objective. For enum values, see Enumeration-Advertising Objectives.
app_promotion_typestringApp promotion type. Enum values: - `APP_INSTALL`: App install. Get new users to install your app. - `APP_RETARGETING`: App retargeting. Re-engage existing users to take action in your app. - `APP_PREREGISTRATION`: App pre-registration. Get new users to pre-register before your app launches. - `APP_POSTS_PROMOTION`: App posts promotion. Promote TikTok posts to increase app awareness and measure conversions. Note: Currently, creating App posts promotion campaigns via API is not supported. You can only update or retrieve such campaigns via API.
virtual_objective_typestringThe new objective type. Enum value: `SALES`. Use this field to create a campaign with the Sales objective, the combined objective for Website Conversions and Product Sales objectives. Learn more about the Sales objective.
sales_destinationstringSales destination, the destination where you want to drive your sales. Enum values: - `TIKTOK_SHOP`: TikTok Shop. Drive sales on your TikTok Shop. - `WEBSITE`: Website. Drive sales on your website. - `APP`: App. Drive sales on your app (product catalog required). - `WEB_AND_APP`: Website and app. Drive sales on both your website and your app.
is_search_campaignbooleanWhether the campaign is a Search Ads Campaign. With Search Ads Campaigns, you can select keywords and serve ads within TikTok's search result page. Supported values: `true`, `false`.
is_smart_performance_campaignbooleanWhether the campaign is an automated campaign type. Supported values: - `true`: The campaign is either a Smart+ Campaign or a Smart Performance Web Campaign. - `false`: The campaign is a standard campaign type. Note: If `is_smart_performance_campaign` is `true` and `objective_type` is `WEB_CONVERSIONS`, you can confirm whether the web campaign is a Smart+ Web Campaign or Smart Performance Web Campaign by checking the returned `spc_type` from /campaign/spc/get/.
campaign_typestringCampaign Type, which indicates the campaign is a regular campaign or iOS 14 campaign. Enum values: `REGULAR_CAMPAIGN`, `IOS14_CAMPAIGN`.
app_idstringThe Application ID of the promoted app. You can get `app_id` by using the /app/list/ endpoint.
is_advanced_dedicated_campaignbooleanWhether the campaign is an Advanced Dedicated Campaign. Advanced Dedicated Campaigns leverage advanced delivery models that benefit from real-time signals. Enum values: `true`, `false`.
disable_skan_campaignbooleanWhether to disable SKAN (SKAdNetwork) attribution, Apple's conversion attribution solution for iOS campaigns. Enum values: - `true`: To disable SKAN attribution. The campaign will not be bound by Dedicated Campaign quota limits and you will be able to retrieve Self Attribution Network (SAN) metrics for the campaign. However, you cannot retrieve SKAN reporting metrics for the campaign. Learn more about SAN integration. - `false`: To enable SKAN attribution. The campaign will be bound by Dedicated Campaign quota limits and you will be able to retrieve SKAN metrics for the campaign.
bid_align_typestringThe attribution type for the Dedicated Campaign. The type determines which attribution network the target CPA (`conversion_bid_price`) or ROAS (`roas_bid`) at the ad group level is based on. Enum values: - `SAN`: SAN. - `SKAN`: SKAN.
campaign_app_profile_page_statestringIndicates the status of App Profile Page. Enum values: `INVALID`, `UNSET`, `ON`, `OFF`.
rf_campaign_typestringWhen `objective_type` is specified as `RF_REACH`, this field shows whether the campaign has been set as a TikTok Pulse campaign. Enum values: `STANDARD` (Reach & Frequency campaign), `PULSE` (TikTok Pulse campaign).
campaign_product_sourcestringReturned only when `objective_type` for the campaign is `PRODUCT_SALES` and the product source is configured for the campaign. Product source of the campaign. Enum values: - `CATALOG` : Catalog. - `STORE`: TikTok Shop, or TikTok Showcase.
catalog_enabledbooleanWhether to use your catalog to automatically advertise relevant products or services to people based on their unique interests, intent and actions.
campaign_namestringCampaign name.
special_industriesstring[]Special ad categories. Enum values: - `HOUSING`: Ads for real estate listings, homeowners insurance, mortgage loans or other related opportunities. - `EMPLOYMENT`: Ads for job offers, internship, professional certification programs or other related opportunities. - `CREDIT`: Ads for credit card offers, auto loans, long-term financing or other related opportunities.
budget_optimize_onbooleanReturned only for campaigns with Campaign Budget Optimization (CBO) enabled. Whether CBO is enabled. Enum values: `true` (enabled). For details about CBO, see Campaign Budget Optimization.
bid_typestringBidding strategy on the campaign level.
deep_bid_typestringBidding strategy for in-app events. For enum values and their descriptions, see Enumeration - Deep-level Bidding Strategy.
roas_bidfloatROAS goal for Value Optimization.
optimization_goalstringOptimization goal.
budget_modestringBudget mode. Enum values: - `BUDGET_MODE_INFINITE`: Unlimited budget. - `BUDGET_MODE_TOTAL`: Lifetime budget. - `BUDGET_MODE_DAY` : Daily budget. - `BUDGET_MODE_DYNAMIC_DAILY_BUDGET`: Dynamic daily budget. It is the average daily budget over a week. Daily costs will not exceed 125% of the average daily budget. Weekly costs will not exceed the average daily budget * 7.
budgetfloatCampaign budget.
rta_idstringRealtime API (RTA) ID, the RTA strategy identifier.
rta_bid_enabledbooleanWhether to use RTA bid. Supported values: - `true`: enabled. - `false`: not enabled.
rta_product_selection_enabledbooleanWhether to use RTA to automatically select products. Enum values: - `true`: enabled. - `false`: not enabled.
operation_statusstringOperation status. Enum values: - `ENABLE` : The campaign is enabled (in 'ON' status). - `DISABLE`: The campaign is disabled (in 'OFF' status).
secondary_statusstringCampaign status (Secondary status).
postback_window_modestringThe mode that determines which SKAN 4.0 postback you want to secure. Enum values: - `POSTBACK_WINDOW_MODE1`: This option secures the first postback, which corresponds to the 0-2 day attribution window. The data can take up to 4 days to return, and the campaign will wait for 4 days to release the campaign quota. - `POSTBACK_WINDOW_MODE2`: This mode secures the first two postbacks, which correspond to the 3-7 day attribution window. The data can take up to 13 days to return, and the campaign will wait for 13 days to release the campaign quota. - `POSTBACK_WINDOW_MODE3`: This mode secures all three postbacks, which correspond to the 8-35 day attribution window. The data can take up to 41 days to return, and the campaign will wait for 41 days to release the campaign quota. Note: If you have set up Mobile Measurement Partner (MMP) Tracking with Adjust, Airbridge, Appsflyer, Branch, Kochava, or Singular for your App and your MMP SDK version is updated to a SKAN 4.0 supported SDK, you can transition your App to SKAN 4.0 on Events Manager. To learn about how to set up MMP tracking for your App, see How to Set Up App Attribution in TikTok Ads Manager. To learn more about how to transition your App to SKAN 4.0, see About SKAN 4.0 and TikTok and How to transition to SKAN 4.0.
is_new_structureboolWhether the campaign is a new structure (for the same campaign, the structure of campaign, ad groups and ads are the same).
objectivestringCampaign type (application or landing page). Enum values: `APP`(application), `LANDING_PAGE`(Landing page).
po_numberstringPO (purchase order) number. PO numbers are useful for invoice tracking and reconciliation. Learn more about PO numbers on monthly invoices.

Response sample

HTTPS/1.1 200 OK
{
    "code": 0,
    "message": "OK",
    "request_id": "{{request_id}}",
    "data": {
        "is_new_structure": true,
        "secondary_status": "CAMPAIGN_STATUS_ENABLE",
        "campaign_type": "REGULAR_CAMPAIGN",
        "budget": {{budget}},
        "budget_mode": "BUDGET_MODE_TOTAL",
        "special_industries": [],
        "deep_bid_type": null,
        "advertiser_id": "{{advertiser_id}}",
        "objective_type": "TRAFFIC",
        "create_time": "{{create_time}}",
        "operation_status": "ENABLE",
        "is_smart_performance_campaign": false,
        "campaign_id": "{{campaign_id}}",
        "roas_bid": 0,
        "campaign_name": "{{campaign_name}}",
        "objective": "LANDING_PAGE",
        "rf_campaign_type": "STANDARD",
        "modify_time": "{{modify_time}}"
    }
}
(/code);

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