Endpoints for submitting and managing bulk data ingestion jobs. Use these endpoints to upload large datasets in a single request and monitor the processing status asynchronously. Typical use cases include importing records in batch and retrieving job completion results via status checks.
This endpoint allows clients to submit multiple user attribute updates in bulk, accepting up to 256 payloads per request. Each request is validated, and a unique batch ID is returned for tracking the status of the batch.
The bulk job request was successfully received and accepted for asynchronous processing. The response includes a batchJobId to track the status of the job, along with a confirmation message. Processing has not yet completed, please use the job status endpoint to monitor progress and retrieve results once available.
Invalid parameter in request query or body
Unauthorized
Access Denied
The specified resource was not found
The user has sent too many requests in a given amount of time
Internal Server Error
{- "users": [
- {
- "attributes": {
- "firstName": "John",
- "lastName": "Smith",
- "demographic": {
- "language": "English/American",
- "dateOfBirth": "2022-11-08",
- "age": 29,
- "organization": "Acme Sports",
- "title": "Mr",
}, - "location": {
- "address1": "456 Elm Avenue",
- "address2": "Suite 300",
- "city": "Brooklyn",
- "state": "NY",
- "zip": "11222",
- "latitude": "40.730610",
- "longitude": "-73.935242",
- "country": "US",
- "region": "AU-NSW",
- "timezone": "EST"
}, - "locale": {
- "language": "French",
- "country": "CA"
}, - "custom": {
- "lucky number": 6,
- "favorite color": "green",
- "has pets": true
}
}, - "subscriptions": [
- {
- "signUpSourceId": "string",
- "channel": "TEXT",
- "singleOptIn": true
}
], - "identifiers": {
- "email": "jsmith@attentive.com",
- "phone": "+15008675309",
- "shopifyId": "345678901",
- "klaviyoId": "a1b2c3d4e5f6a7b8c9d0e1f2",
- "clientUserId": "freeform-client-id",
- "customIdentifiers": [
- {
- "key": "loyalty_points_id",
- "value": "ADFK4D7D"
}
]
}
}
]
}
{- "message": "string",
- "batchJobId": "string"
}