Developer resources

Create a test lead — TikTok Business API

Create a test lead · 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

Create a test lead

POST/page/lead/mock/create/Via 360: POST https://partner.quantri360.com/v1/tiktok_business/page/lead/mock/create/

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 perform end-to-end testing for lead generation.

For each Instant Form, you can create one test lead. If you need to create a new test lead, you must delete the existing test lead using /page/lead/mock/delete/ first. If you want to fetch the Instant Form fields, you can use /page/field/get/ to get field info directly.

Request

Endpoint

POST https://partner.quantri360.com/v1/tiktok_business/page/lead/mock/create/

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
lead_source	body	string	No	The source of the lead. Enum values: - `INSTANT_FORM`: a lead generated through an Instant Form. - `DIRECT_MESSAGE`: a lead generated from a direct message of the associated Business Account. Default value: `INSTANT_FORM`.
library_id	body	string	No	Required when you want to create a test lead under a form library of a Business Center. ID of a form library. To obtain the list of form libraries within a Business Center, use /page/library/get/.
page_id	body	string	No	- Required when `lead_source` is `INSTANT_FORM` or not specified. - Not supported when `lead_source` is `DIRECT_MESSAGE`. The page ID of an Instant Form. To obtain a list of Instant Forms, use /page/get/ and set `business_type` to `LEAD_GEN`.

Request examples

curl -s -X POST "https://partner.quantri360.com/v1/tiktok_business/page/lead/mock/create/" \
  -H "Authorization: Bearer $KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

Python

import requests

KEY = "q360_live_..."  # khóa API của brand
r = requests.post(
    "https://partner.quantri360.com/v1/tiktok_business/page/lead/mock/create/",
    params={},
    json={},
    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/page/lead/mock/create/');
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({}),
});
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/page/lead/mock/create/' . '?' . 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, '{}');
$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	The response code. For the complete list of response codes and descriptions, see Appendix - Return Codes.
message	string	The response message. For details, see Appendix - Return Codes.
request_id	string	The log id of the request, which uniquely identifies a request.
data	object	The returned data.
lead_data	object	The lead data.
meta_data	object	Metadata about the lead.
lead_source	string	The source of the lead. Enum values: - `INSTANT_FORM`: a lead generated through an Instant Form. - `DIRECT_MESSAGE`: a lead generated from a direct message of the associated Business Account.
lead_id	string	The lead ID.
page_id	string	Returned only when `lead_source` is `INSTANT_FORM`. The page ID of the Instant Form.
campaign_id	string	The campaign ID.
campaign_name	string	The campaign name.
adgroup_id	string	The ad group ID.
adgroup_name	string	The ad group name.
ad_id	string	The ad ID
ad_name	string	The ad name.
create_time	datetime	The creation time of the test lead.

Response sample

HTTPS/1.1 200 OK
{
    "code":0,
    "message":"OK",
    "request_id":"202208010308080102450041491221C41E",
    "data":{
        "meta_data":{
            "create_time":1659323289,
            "campaign_id":1679105346952197,
            "campaign_name":"test lead: dummy data for campaign name",
            "adgroup_id":1679105346954261,
            "adgroup_name":"test lead: dummy data for ad group name",
            "lead_id":7126711421177430274,
            "ad_id":1679105346954262,
            "ad_name":"test lead: dummy data for ad name",
            "page_id":6873052183063953666
        },
        "lead_data":{
            "name":"Jane Doe",
            "phone_number":"8001000000",
            "Availability":"test lead: dummy data for Availability"
        }
    }
}
(/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