Create New Audiences

Prev Next
Post
/audiences

This API creates a new Audience and returns an Audience ID.

Request uses multipart/form-data and includes a CSV or Excel file uploaded from your local machine. The file must include a column named phone1 with full country-code phone numbers (e.g., 442079832100).

Body Parameters (multipart/form-data)

  • name (required): The name for the new audience (Example: name=NE_USA-above50)
  • audience_file (required): A CSV or Excel file with customers data. Use @ followed by the local file path (Example: audience_file=@/Users/john/downloads/audience.csv)
Security
HTTP
Type bearer

API key is needed to authorize requests. You can get your API key via the management console.
A Bearer Token is needed to be set in the Authorization header of every API call.
For additional support you can contact us.

Body parameters
object
name
string Required

Name for the new audience

Examplename=NE_USA-above50
audience_file
string (binary) Required

URL of the CSV or Excel file with customers' data

ExampleYXVkaWVuY2VfZmlsZT1AL3BhdGgvdG8vYXVkaWVuY2UuY3N2
Responses
201

Audience created

Expand All
object
status
integer
Example201
description
string
ExampleAudience created
response_time
string (date-time)
Example2025-02-06T07:51:52.258Z
data
object
id
string

The new Audience ID

Example312345
400

Bad Request - Missing required fields, invalid file format, or missing phone1 column

object
status
integer
Example400
description
string
ExampleBad Request
response_time
string (date-time)
Example2025-02-06T07:51:52.258Z
401

Unauthorized - Invalid or missing Bearer token

object
status
integer
Example401
description
string
ExampleUnauthorized
response_time
string (date-time)
Example2025-02-06T07:51:52.258Z
429

Too Many Requests - Too many requests have been made in a short period of time (Throttling)

object
status
integer
Example429
description
string
ExampleToo Many Requests – Rate limit exceeded
response_time
string (date-time)
Example2025-02-06T07:51:52.258Z
500

Internal Server Error

object
status
integer
Example500
description
string
ExampleServer Error
response_time
string (date-time)
Example2025-02-06T07:51:52.258Z