Skip to main content
POST
Create a client

Autorizaciones

Authorization
string
header
requerido

API key created in the dashboard under Settings → API Keys. Send it as Authorization: Bearer pk_....

Cuerpo

application/json

Public API request schema for creating a client.

first_name
string | null

Given name.

last_name
string | null

Family name.

area_code
string | null
predeterminado:""

Country calling code (for example 52) stored alongside the phone number. Optional when phone_number is already in E.164 format.

phone_number
string | null

Phone number, preferably E.164 (+525512345678). Required unless email is provided.

email
string | null

Email address. Required unless phone_number is provided.

company
string | null

Company or organization name.

timezone
string
predeterminado:UTC

IANA timezone of the contact (for example America/Bogota).

data
Data · object | null

Free-form custom fields stored on the contact and available to agents as prompt variables.

tags
PublicTagSchema · object[] | null

Tags to attach. Tags that do not exist yet are created.

Respuesta

Created

Public API response schema for created client.

status
string
requerido

Response status

Allowed value: "success"
client_id
integer
requerido

Unique identifier for the created client

message
string
requerido

Human-readable success message