Crear un Cliente
Crea un nuevo cliente en el sistema.
POST https://api.platica.mx/v1/clients Cuerpo de la solicitud
| Campo | Tipo | Descripción | Requerido |
|---|---|---|---|
name | string | Nombre completo del cliente | ✓ |
phoneNumber | string | Número telefónico en formato E.164 sin + | ✓ |
firstname | string | Primer nombre del cliente | — |
lastname | string | Apellido del cliente | — |
email | string | Email del cliente | — |
birthdate | string | Fecha de nacimiento. Formato: dd/mm/yyyy | — |
gender | enum | Género: male o female | — |
company | string | Nombre de la compañía | — |
country | enum | País de residencia (código ISO 3166-1 alpha-2) | — |
state | string | Estado de residencia | — |
city | string | Ciudad de residencia | — |
address | string | Dirección completa | — |
postalCode | string | Código postal | — |
tags | array | Arreglo de etiquetas | — |
customFields | object | Campos personalizados (ver Campos Personalizados ) | — |
owners | array | Lista de correos de usuarios responsables del cliente | — |
Ejemplo de solicitud
{
"name": "José Pérez",
"phoneNumber": "524491234567",
"email": "jose@platica.mx",
"tags": ["vip"],
"customFields": {
"placas": "ABC123",
"id_recepcion": "REC001"
}
} Campos personalizados de selección (select)
Para un campo personalizado de tipo select, envía en customFields el id o la etiqueta de una opción activa; la API lo convierte y guarda el id de la opción.
{
"name": "José Pérez",
"phoneNumber": "524491234567",
"customFields": {
"etapa_de_venta": "Contactado"
}
} - Si el valor no corresponde a ninguna opción activa del campo, la API devuelve
400. - Para limpiar el valor de un
select, envíanullo una cadena vacía"".
Respuesta
{
"status": "success",
"message": "Client created successfully",
"data": {
"id": "274fc73cb7d84a17955914fdc1a1f9d0",
"wasUpdated": false
}
} Notas sobre la respuesta
wasUpdated: falseindica que se creó un cliente nuevowasUpdated: trueindica que ya existía un cliente con ese teléfono y fue actualizado en lugar de crear uno nuevo