> For the complete documentation index, see [llms.txt](https://docs.edgetag.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.edgetag.io/channels/snapchat/api.md).

# 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/72/channels/snapchat/configuration) for detailed information on the purpose and usage of each input.

### SNAPCHAT\_ACCESS\_TOKEN

In this secret, you would store the access token that you got back from the Snapchat OAuth process.\
\
**Example value**\
eyJpc3MiOiJodHRwczpcL1wvYWNjb3VudHMuc25hcGNoYXQuY29tXC9hY2NvdW50c1wvb2F1dGgyXC9782tlbiIsInR5cCI6IkpXVCIsImVuYyI6IkExMjhDQkMtSFMyNTYiLCJhbGciOiJkaXIiLCJraWQiOiJhY2Nlc3MtdG9rZW4tYTEyOGNiYy1oczI1Ni4wIn0..pOimkM2ckiWsborD1mpa4g.S4kSL6vVHBsVIZFxpMm6z5XMgjhW5p8DWFn0O9FfAeUDoWs8p2jppWHiOXTFHJHu8dM2-Rdzoe7SR8HQLko4YYJKSRXFY3QlYlUtL8OMO0\_8EeiJf-YdnYQraEfZATfH0-PWhxk6eZIdnZLxIhwqpUILIO7moWtBbFib5HA0ZFzyuAt6e78Lov1Ebwa-AbBivemAN6wbs2KYEoClJRAYf\_SS6KtDcx\_h7WeOf6zFiL3ylXjCSx0LnQ6ylvNBAgzXOl3OrUCBwJDx6HWnDmaq0nc8hlTDGQtRHlj7Vi-m5VQwjAg4uS-8Tv5h7OrpRCPPCc7fTlgtXVgAa3K2dYNnCGfCQgO\_21zqNd4f4sKmewPWcOBYyScAWpCoeEMTIChGBmk-cixtR375sPMwARgXgxDw\_3oP7T3tNE7VCSgzhYR5GvfrNzjFLPMFFrEqzbbMWH7hKFI9saSydHBaU9NYRTCDjZEodC8j3GUY2qA0IcfIPXytWbUEpttCYbaGpD5HDDTnQdAqmle1CU3aQqnxe3R8H8SZ12YyqOPv583AZ86ApBYmXFrQXnAZFurHupEqSgW2DkB6rkoeNdznaHwP5r3n1PEhbHkJDrL05hfKMQHiP5rMo10CyN-p-RO\_0uHTYKUak8K\_6crvdm4fqzwZ\_oK9-cVCrQjUXS-ZeEP\_zcFkDbRiYJFN71HiW4AW7ciCK3dUcsfhAwdr7bhmWWeliFSWfKsNpdMUiLijZiNJ4886p6y-HkXFz-Li2ZL8B9hmkkcgWZ96q1ZBTyJ8QSvOF3HCBUQVfBsGJvL4RJZejvv9x72-oeV\_h\_xEZ-8iFxbP.OWFAROZp73jxIzPA-dr2BZ\
\
**Type**\
PASSWORD\
\
**Optional**\
false

### SNAP\_PIXEL\_ID

Use for storing Snapchat Pixel ID or Event Source ID.

**Example value**\
20ffa1ea-52f0-4ca6-b5be-ae4462dfe481\
\
**Type**\
IDENTIFIER\
\
**Optional**\
false

### SNAP\_BROWSER\_PIXEL

See the [config description](/channels/meta/configuration.md#enable-browser-pixel).

**Possible values**\
1 or 0

**Type**\
CHECKBOX

**Optional**\
true

### SNAP\_PRODUCT\_ID\_MAPPING

See the [config description](/channels/meta/configuration.md#product-id-mapping).

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

**Type**\
TEXT

**Optional**\
true

### SNAP\_TEST\_MODE

See the [config description](/channels/meta/configuration.md#event-test-code).

**Example value**\
1 or 0

**Type**\
CHECKBOX

**Optional**\
true


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## 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, and the optional `goal` query parameter:

```
GET https://docs.edgetag.io/channels/snapchat/api.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.