Developer resources

Apply audiences to ad groups — TikTok Business API

Apply audiences to ad groups · 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.

Open in the API index TikTok Business platform page

Apply audiences to ad groups

POST/dmp/custom_audience/apply/Via 360: POST https://partner.quantri360.com/v1/tiktok_business/dmp/custom_audience/apply/

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 apply audience to or disconnect audience from multiple ad groups.

Request

Endpoint

POST https://partner.quantri360.com/v1/tiktok_business/dmp/custom_audience/apply/

Authentication & shop

Name	In	Type	Sample	Description
Authorization	header	header	Bearer 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_id	query	string	7000000000000000001	Tà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

Name	In	Type	Required	Description
custom_audience_id	body	string	Yes	Custom audience ID. You can only pass one custom audience ID.
adgroup_ids	body	string[]	Yes	A list of ad group IDs. Note: - `adgroup_ids` and `custom_audience_id` should be under the same advertiser account. Otherwise, an error will occur. - Lookalike Audience cannot be used in Reach & Frequency ads. Otherwise, an error will occur. See below for more details. 1. If the `custom_audience_id` is a Lookalike Audience and the `adgroup_ids` are Reach & Frequency ad groups, an error will occur.2. If the `custom_audience_id` is a Lookalike Audience with the `REACH_FREQUENCY` audience subtype, an error will occur.
action_mode	body	string	Yes	Specific operation to be performed on the audience. Enum values: `Apply`, `Disconnect`.
usage_mode	body	string	No	Whether to include this audience in or exclude it from your ad groups. Required when `action_mode` is Apply. Enum values: `Include`, `Exclude`.

Request examples

curl -s -X POST "https://partner.quantri360.com/v1/tiktok_business/dmp/custom_audience/apply/" \
  -H "Authorization: Bearer $KEY" \
  -H "Content-Type: application/json" \
  -d '{"custom_audience_id":"","adgroup_ids":[],"action_mode":""}'

Python

import requests

KEY = "q360_live_..."  # khóa API của brand
r = requests.post(
    "https://partner.quantri360.com/v1/tiktok_business/dmp/custom_audience/apply/",
    params={},
    json={
        "custom_audience_id": "",
        "adgroup_ids": [],
        "action_mode": ""
    },
    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/dmp/custom_audience/apply/');
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({"custom_audience_id":"","adgroup_ids":[],"action_mode":""}),
});
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/dmp/custom_audience/apply/' . '?' . 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, '{"custom_audience_id":"","adgroup_ids":[],"action_mode":""}');
$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)

Name	Type	Description
code	number	Response code. For the complete list of response codes and descriptions, see Appendix - Return Codes.
message	string	Response message. For details, see Appendix - Return Codes.
data	object	Returned Data.
request_id	string	The log ID of a request, which uniquely identifies the request.

Response sample

HTTPS/1.1 200 OK
{
    "code": 0,
    "message": "OK",
    "request_id": "123",
    "data": {}
}
(/code);

Get started

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