This API replaces all customers in an existing Static Audience with the records provided in the uploaded file. After processing, the audience will contain only the customers from the newly uploaded file, and all previously stored customer records will be removed.
Body Parameters (multipart/form-data)
audience_file(required): A CSV or Excel file with the updated customers data. Use@followed by the local file path (Example: audience_file=@/Users/john/downloads/audience.csv)
Note:
- HTTP method must be PUT
- Only Static audiences can be updated. Attempting to update a Dynamic audience will return '400 - Bad Request'.
- Only the audience_file field is accepted; no other audience properties can be modified through this endpoint.
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.
A CommBox generated number for the Audience
URL of the CSV or Excel file with the updated customers' data
OK
The updated Audience ID
Bad Request - Missing required fields, invalid file format, or missing phone1 column
Unauthorized - Invalid or missing Bearer token
Not found - No audience exists with the given ID
Too Many Requests - Too many requests have been made in a short period of time (Throttling)
Internal server error