Create

Audience APIs allow brands to Create, Update, Replace, Remove, List and View Audiences.

Audiences are lists of Custom User IDs that can be used for targeting with Batch Platform, when performing Email Campaigns and Automations.

Audiences can also be associated with attributes that can be used for personalization purposes (more information here).

API Description

Create

post

Create an audience.

Authorizations

Header parameters

X-Batch-Projectstringrequired

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

Example: project_0664hxvwffvbpn278gxdyhsadddqgna6

Body

namestring · max: 255required

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.

typestring · enumrequiredAvailable options:

display_namestringoptional

Responses

application/json

objectoptional

application/json

application/json

application/json

application/json

application/json

post

HTTPcURLJavaScriptPython

POST /2.4/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"
}

{
  "indexing_token": "text"
}

Request structure

Route

The Audience API exposes a POST endpoint that allows to create an audience:

https://api.batch.com/2.4/audiences/create

Headers and authentication

See Overview → Using Project APIs.

Post data

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:

{
  "name": "AUDIENCE_NAME",
  "display_name": "The audience description",
  "type": "custom_ids"
}

Responses

Success

If the POST to the API endpoint is successful you will receive an HTTP 202 confirmation and a token.

{
  "indexing_token": "a0082dc6860938a26280bd3ba927303b"
}

Once you get your token, you can use it to check the indexing state of this update with the API.

Failure

If the POST data does not meet the API requirements you will receive an actionable error message. Contact us at [email protected] if you need further support.