VI | EN
Message us on Messenger
Developer resources

Update an Offline Event set — TikTok Business API

Update an Offline Event set · 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 an Offline Event set

POST/offline/update/Via 360: POST https://partner.quantri360.com/v1/tiktok_business/offline/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 update the name, the Auto Tracking setting, or both of an Offline Event set.

> Important

> By using Events API endpoints, you agree to the TikTok Business Products (Data) Terms and that you will not share sensitive data with TikTok.

Request

Endpoint

POST https://partner.quantri360.com/v1/tiktok_business/offline/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
event_set_idbodystringYesID of the Offline Event set that you want to update. You can get Offline Event set IDs under an advertiser account via /offline/get/.
namebodystringNoNew name for the Offline Event set. Length limit: 40 characters. Example: in_store_purchases. Note: You cannot specify a name that has been used by another event set. Otherwise, an error will occur.
auto_trackingbodybooleanNoWhether to enable Auto Tracking for the Offline Event set. Enum values: true, false. If this field is set to true, new campaigns created afterwards under this advertiser account will use this event set for ad tracking and attribution. Note: The maximum number of auto-tracking Offline Event sets under an advertiser account is 10. If the limit is reached, you cannot change a non-auto-tracking Offline Event set into an auto-tracking one. However, you can delete an existing Offline Event set using /offline/delete/.

Request examples

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

KEY = "q360_live_..."  # khóa API của brand
r = requests.post(
    "https://partner.quantri360.com/v1/tiktok_business/offline/update/",
    params={},
    json={
        "event_set_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/offline/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({"event_set_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/offline/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, '{"event_set_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
codenumberResponse code. For the complete list of response codes and descriptions, see Appendix-Return Code.
messagestringResponse message. For details, see Appendix - Return Codes.
request_idstringThe log ID of a request, which uniquely identifies the request.
dataobjectReturned data.
advertiser_idstringAdvertiser ID.
event_set_idstringID of the Offline Event set.
namestringName of the Offline Event set.
descriptionstringDescription that you specified for the Offline Event set. Returns `""` if no description has been specified.
auto_trackingbooleanWhether Auto Tracking is enabled for the Offline Event set.
create_timestringThe time when the Offline Event set was created, in ISO 8601 format. Example: `2023-04-15T00:23:38Z`.
update_timestringThe time when the event set was last updated, in ISO 8601 format. Example: `2023-04-15T00:23:38Z`.

Response sample

HTTPS/1.1 200 OK
{
    "code": 0,
    "message": "OK",
    "request_id": "{{request_id}}",
    "data": {
        "name": "{{name}}",
        "advertiser_id": "{{advertiser_id}}",
        "update_time": "2023-05-05T09:53:02Z",
        "create_time": "2023-05-05T09:51:47Z",
        "event_set_id": "{{event_set_id}}",
        "auto_tracking": true,
        "description": "{{description}}"
    }
}

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