Skip to main content
PATCH
Update an end user
Updates fields on one end-user record. Identity fields pass through the same normalization and merge rules as the widget and CSV import. Requires a key with the End-users permission. See API authentication.
string
required
The _id of the record, as returned by list or create.
string
Display name.
string
Email address. A value that belongs to a different record returns 400 with a duplicate error.
string
Phone number. A value that belongs to a different record returns 400 with a duplicate error.
string[]
Tags to apply.
object
Per-channel identifiers.

Response

boolean
true on success.

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.

Path Parameters

endUserId
string
required

The end-user record ID

Body

application/json
name
string

Replacement display name.

email
string

Replacement email address, normalized and checked for duplicates.

phone
string

Replacement phone number, normalized and checked for duplicates.

tags
string[]

Replacement tag list. It replaces the existing tags rather than merging with them.

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.

Response

End user updated

success
boolean
required

True when the record was updated.