The Audience API exposes a POST endpoint that allows to create an audience:
/audiences/create
See .
The body of the request must contain a valid JSON payload describing the operations to be executed on the audience.
Here is a how a complete JSON payload looks like:
If the POST to the API endpoint is successful you will receive an HTTP 202 confirmation and a token.
Once you get your token, you can use it to of this update with the API.
If the POST data does not meet the API requirements you will receive an actionable error message. Contact us at if you need further support.
{
"name": "AUDIENCE_NAME",
"display_name": "The audience description",
"type": "custom_ids"
}{
"indexing_token": "a0082dc6860938a26280bd3ba927303b"
}Create an audience.
Authentication is required in order to interact with Batch's APIs.
Batch implements authentication using API Keys, that we call the "REST API Key". You can find it on your dashboard.
Please make sure that you keep this key secret. You should never use it in client apps to call APIs from there as it would easily be extractable.
In order to authenticate your requests, add your REST API Key in the Authorization header and prefix it by Bearer. Example: Authorization: Bearer bcd38d9rfb38ra28.
The unique project key, identifying a project on the Batch platform
project_0664hxvwffvbpn278gxdyhsadddqgna6The 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.
If the POST to the API endpoint is successful you will receive an HTTP 202 confirmation and an indexing token. Once you get your indexing token, you can use it to check the indexing state with the view action.
The request is malformed
The Rest API Key is not valid for this project
Too Many Requests
Unexpected error
Batch's services are under maintenance. Please try again later
{
"indexing_token": "text"
}POST /2.8/audiences/create HTTP/1.1
Host: api.batch.com
Authorization: Bearer YOUR_SECRET_TOKEN
X-Batch-Project: text
Content-Type: application/json
Accept: */*
Content-Length: 86
{
"name": "AUDIENCE_NAME",
"display_name": "The audience description",
"type": "custom_ids"
}