Skip to main content
POST
Batch-create end users
A batch never fails because of one duplicate row. Tars checks each entry’s email and phone against earlier entries in the same request and against existing records. A match is skipped, and the rest of the batch is still created. Requires a key with the End-users permission. See API authentication.
object[]
required
At most 50 entries. Each entry uses the create fields and needs an origin.

Response

The response reports per-row results.
number
Count of records created.
number
Count of entries skipped as duplicates.
object[]
One entry per skipped row, with its index in the batch and a reason.

Errors

Authorizations

Authorization
string
header
required

API key sent as Authorization: Bearer YOUR_API_KEY. Campaign endpoints use campaign-scoped keys; the rest use organization or agent keys with the matching permission.

Body

application/json
endUsers
object[]
required

The records to create, up to 50 per request. Each row is reported separately, so a duplicate skips that row without failing the call.

Required array length: 1 - 50 elements

Response

Batch result; duplicates are skipped, not failed

created
integer
required

How many records were created.

skipped
integer
required

How many rows were skipped, usually because the email or phone already exists.

errors
object[]
required

One entry per rejected row. The rest of the batch is still created.