Skip to main content
POST
Creates one end-user record. Email and phone are normalized on write. Requires a key with the End-users permission. See API authentication.
string
required
inbound, imported, or manual.
string
Display name.
string
Email address.
string
Phone number.
object
Per-channel identifiers.
string[]
Tags to apply.

Response

Success returns 201.
boolean
true on success.
string
ID of the created record, used in the by-ID endpoints.

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

Fields accepted when creating an end-user record.

origin
enum<string>
required

How the record was created. Required.

Available options:
inbound,
imported,
manual
name
string

Display name.

email
string

Email address. Must be unique in your organization, or the call returns 409 DUPLICATE_ENDUSER.

phone
string

Phone number in international format. Must be unique in your organization, or the call returns 409 DUPLICATE_ENDUSER.

channelIdentifiers
object

Where Tars can reach this end user on each channel. Every field is optional, and only the channels Tars has seen are present.

tags
string[]

Free-form tags to apply to the new record.

Response

End user created

success
boolean
required

True when the record was created.

endUserId
string
required

The new record's ID. Pass it to the single-record endpoints.