latestOpenAPI 3.1.02026-08-10295186.7 KB

ec696334ff35

Audiences

Create

Create an audience.

post/audiences/create

Headers

X-Batch-Projectstring required

The unique project key, identifying a project on the Batch platform

Request body

namestring required

The audience name value must be a string that only contains letters (a-z, A-Z), numbers (0-9) or the following characters : _, -. Audience names can be up to 255 characters long. They are case sensitive.

type'custom_ids' | 'emails' | 'install_ids' required

display_namestring

Response

If the POST to the API endpoint is successful you will receive an HTTP 202 confirmation and an indexing token. <br/>Once you get your indexing token, you can use it to check the indexing state with the view action.

indexing_tokenstring