End users API

The End users API reads and writes the end-user records in your organization. Every request needs an organization-scoped key that holds the End-users permission. Send it as Authorization: Bearer YOUR_API_KEY. See API authentication.

Operations

Operation	Endpoint
List end users	`GET /api/endusers`
Create an end user	`POST /api/endusers`
Batch-create end users	`POST /api/endusers/batch`
Get an end user	`GET /api/endusers/{endUserId}`
Update an end user	`PATCH /api/endusers/{endUserId}`
Delete an end user	`DELETE /api/endusers/{endUserId}`

The end-user record

Responses return this public shape.

string

The record ID, used in the by-ID endpoints.

string

Display name.

string

Email, normalized on write.

string

Phone, normalized on write.

string[]

Free-form tags.

string

inbound, imported, or manual.

object

Per-channel identifiers on this profile.

Per-channel consent state.

number

Creation time, milliseconds since epoch.

number

Last activity time, milliseconds since epoch.

Errors

Error responses use the shape { "error": "…", "code": "…" }.

Status	Code	Cause
`400`	`INVALID_BODY`	Malformed body, or an unknown or missing `origin` on create and batch
`400`	`INVALID_ORIGIN`	The `origin` query value on list is not `inbound`, `imported`, or `manual`
`400`	`INVALID_URL`	The by-ID path does not match `/api/endusers/{endUserId}`
`400`	`CREATE_FAILED`, `UPDATE_FAILED`, `DELETE_FAILED`	The write failed, including a duplicate email or phone on update
`401`	`UNAUTHORIZED`	Missing, invalid, or revoked key
`403`	`FORBIDDEN`	Key lacks the End-users permission
`404`	`NOT_FOUND`	No record matches the ID
`405`	`METHOD_NOT_ALLOWED`	The method is not supported on this route
`409`	`DUPLICATE_ENDUSER`	Create only. Email or phone already exists on another record

Welcome

Core concepts

Guides

Developer

Operations

The end-user record

Errors

​Operations

​The end-user record

​Errors

​Related pages

Operations

The end-user record

Errors

Related pages