Create static audience

Creates a new static audience based on file.

The audience represents a set of recipients for the campaign. It consists of contact data that will be used to launch the campaign.

To upload a file you'll need to send a request of type multipart/form-data. The request should contain the file you would like to upload, as well as the parameters for creating a audience.

The file will go through a series of checks to validate that it is correctly formatted and meets specifications. We return an error for uploads that fail any of our checks.

Checks we perform:

  • File extension.
  • File size.
  • Number of lines.
  • File header.
  • Column separator.
  • Field format.
Body Params
string
required

The audience name.

file
required

A file to upload in csv format. The file cannot exceed 100k lines and maximum size of 6MB.

The csv file must have the following columns with the specified separator:

  country-code, area-code, number

Or with the full phone number:

  fullNumber
string

Each record has one or more "fields" separated by a delimiter. If the delimiter used in the CSV file is different from ',' (comma), ';' (semicolon), ' ' (tab) send in this field so that we can recognize it.

string
enum

Used to translate error messages when validating contacts from audience, by default the value is pt

Allowed:
Responses

Language
Credentials
URL
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json