Customers

ToolREST endpointAnnotations
list_clientsGET /v1/clientsread-only, idempotent
get_clientGET /v1/clients/{identifier}read-only, idempotent
create_clientPOST /v1/clientswrite (upsert if it already exists)
update_clientPATCH /v1/clients/{phoneNumber}write, partial
delete_clientDELETE /v1/clients/{identifier}destructive

list_clients

Lists customers in the workspace grouped, with pagination and optional filters.

FieldTypeDefault
limit1-20050
offset≥ 00
sortBy"name" \| "creationDate"name
sortDirection"asc" \| "desc"asc
searchTermstring
tagsstring[] (max 10)
dateFilterobject

get_client

FieldTypeRequiredDescription
identifierstringyesCustomer ID or phone number (E.164).

create_client

Creates a new customer; if one with the same phone number already exists, it updates it (upsert).

FieldTypeRequired
phoneNumberstring E.164yes
namestringyes
workspacestringif multi-ws
email, firstname, lastname, birthdate, gender, company, country, state, city, address, postalCodestringno
tagsstring[]no
customFieldsRecord<string, unknown>no
ownersstring[]no

Example

{
  "name": "create_client",
  "arguments": {
    "phoneNumber": "+521234567890",
    "name": "Ana López",
    "email": "ana@example.com",
    "tags": ["vip", "nuevo"]
  }
}

update_client

Updates a customer by phone number. Only the fields provided are applied.

Accepts the same fields as create_client (all optional except phoneNumber), plus:

FieldTypeDescription
status"active" \| "blocked"Customer status.

delete_client

FieldTypeRequired
identifierstringyes
workspacestringif multi-ws

Irreversible operation.