Clientes

ToolEndpoint RESTAnotaciones
list_clientsGET /v1/clientslectura, idempotente
get_clientGET /v1/clients/{identifier}lectura, idempotente
create_clientPOST /v1/clientsescritura (upsert si ya existe)
update_clientPATCH /v1/clients/{phoneNumber}escritura, parcial
delete_clientDELETE /v1/clients/{identifier}destructiva

list_clients

Lista clientes del workspace agrupados, con paginación y filtros opcionales.

CampoTipoDefault
limit1-20050
offset≥ 00
sortBy"name" \| "creationDate"name
sortDirection"asc" \| "desc"asc
searchTermstring
tagsstring[] (máx 10)
dateFilterobjeto

get_client

CampoTipoRequeridoDescripción
identifierstringID del cliente o número de teléfono (E.164).

create_client

Crea un nuevo cliente; si ya existe uno con el mismo teléfono, lo actualiza (upsert).

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

Ejemplo

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

update_client

Actualiza un cliente por su número de teléfono. Sólo se aplican los campos provistos.

Acepta los mismos campos que create_client (todos opcionales excepto phoneNumber) más:

CampoTipoDescripción
status"active" \| "blocked"Estado del cliente.

delete_client

CampoTipoRequerido
identifierstring
workspacestringsi multi-ws

Operación irreversible.