API Responses

API Responses

Success (200)

{
"success": true
}

Validation Error — Malformed Body (400) Returned when the request body is not valid form data:

Malformed request body, must be form data (<error details>)

Validation Error — Corrupted Payload (400)

{
"success": false,
"errors": [
"Payload is corrupted or missing. Please send JSON string. <error>"
]
}

Validation Error — Empty Users (400)

No users in the segment. Segment cannot be created.

Provider Errors (400, sync mode only)

{
"success": false,
"errors": [ "" ]
}

Batching & Large Audiences

For large audiences that exceed practical request size limits, the API supports splitting users across multiple requests using the batch metadata:

• Split your user list into chunks (e.g., 10,000 users per batch)
• Generate a unique sessionId for the entire upload
• Send each chunk as a separate API call with incrementing sequence numbers
• Set totalBatches and totalUsers consistently across all requests

Example: To upload 25,000 users in 3 batches, each request would share the same sessionId , have totalBatches: 3 , totalUsers: 25000 , and individual sequence values of 1, 2, and 3.

POST /audience?disablePrefix=false&sync=true
Content-Type: multipart/form-data; boundary=----FormBoundary
------FormBoundary
Content-Disposition: form-data; name="name"
High Value Customers Q1
------FormBoundary
Content-Disposition: form-data; name="type"
custom
------FormBoundary
Content-Disposition: form-data; name="batch"
{"sessionId":1708531200,"sequence":1,"totalBatches":3,"totalUsers":25000,"pullDate":"2026-01-01"}
------FormBoundary
Content-Disposition: form-data; name="users"
[{"edgeTagId":"et_abc123","email":"[e-mail]","phone":"+1415555","firstName": "john","lastName": "doe","country": "US","postalCode": "90202","purchase":[..]},.....................]
------FormBoundary--