# API

{% hint style="warning" %}
This section is intended for developers utilizing our APIs to add channels.
{% endhint %}

Below you will find the keys to generate secret payloads for adding or updating a channel via the [Script API](/api/api/script.md).

Refer to the [configuration page](https://app.gitbook.com/o/c0Wts1N48p0Ba5S58p8v/s/ZJWZKbUk0hRISkCIj2p4/~/changes/85/channels/tiktok/configuration) for detailed information on the purpose and usage of each input.

### TT\_OAUTH\_ACCESS\_TOKEN

In this secret, you would store the access token obtained from the TikTok OAuth process.\
\
**Example value**\
012cb7a37cea4p4b05ac0233c498d8aac4c33e53\
\
**Type**\
PASSWORD\
\
**Optional**\
false

### TT\_PIXEL\_ID

Use for storing the Pixel ID.

**Example value**\
CM08ISRC77U2H4CKPULG\
\
**Type**\
IDENTIFIER\
\
**Optional**\
false

### TT\_PURCHASE\_EVENT

Please always send the value as **'CompletePayment'** if it has not been configured earlier. See the [config description](https://app.gitbook.com/o/c0Wts1N48p0Ba5S58p8v/s/ZJWZKbUk0hRISkCIj2p4/~/changes/85/channels/tiktok/onboarding#purchase-event).

**Example value**\
CompletePayment or PlaceAnOrder

**Type**\
TEXT

**Optional**\
true

### TT\_ADVERTISER\_ID

Use for storing Ad Account ID

**Example value**\
7276450817098661891\
\
**Type**\
TEXT\
\
**Optional**\
false

### TT\_BROWSER\_PIXEL

See the [config description](https://app.gitbook.com/o/c0Wts1N48p0Ba5S58p8v/s/ZJWZKbUk0hRISkCIj2p4/~/changes/85/channels/tiktok/configuration#enable-browser-pixel).

**Possible values**\
1 or 0

**Type**\
CHECKBOX

**Optional**\
true

### TT\_PRODUCT\_ID\_MAPPING

See the [config description](https://app.gitbook.com/o/c0Wts1N48p0Ba5S58p8v/s/ZJWZKbUk0hRISkCIj2p4/~/changes/85/channels/tiktok/configuration#product-id-mapping).

**Possible values**\
0 for Product ID\
1 for Variant ID\
2 for SKU 

**Type**\
TEXT

**Optional**\
true

### TT\_OFFLINE\_SET\_ID

See the [config description](https://app.gitbook.com/o/c0Wts1N48p0Ba5S58p8v/s/ZJWZKbUk0hRISkCIj2p4/~/changes/85/channels/tiktok/configuration#offline-event-set-id).

**Example value**\
7298285311644254209

**Type**\
TEXT

**Optional**\
true

### TT\_PIXEL\_TEST

See the [config description](https://app.gitbook.com/o/c0Wts1N48p0Ba5S58p8v/s/ZJWZKbUk0hRISkCIj2p4/~/changes/85/channels/tiktok/configuration#event-test-code).

**Example value**\
TEST39331

**Type**\
TEXT

**Optional**\
true


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.edgetag.io/channels/tiktok/api.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.