Crear un Cliente

Crea un nuevo cliente en el sistema.

POST https://api.platica.mx/v1/clients

Cuerpo de la solicitud

CampoTipoDescripciónRequerido
namestringNombre completo del cliente✓
phoneNumberstringNúmero telefónico en formato E.164 sin +✓
firstnamestringPrimer nombre del cliente—
lastnamestringApellido del cliente—
emailstringEmail del cliente—
birthdatestringFecha de nacimiento. Formato: dd/mm/yyyy—
genderenumGénero: male o female—
companystringNombre de la compañía—
countryenumPaís de residencia (código ISO 3166-1 alpha-2)—
statestringEstado de residencia—
citystringCiudad de residencia—
addressstringDirección completa—
postalCodestringCódigo postal—
tagsarrayArreglo de etiquetas—
customFieldsobjectCampos personalizados (ver Campos Personalizados )—
ownersarrayLista 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ía null o una cadena vacía "".

Respuesta

{
  "status": "success",
  "message": "Client created successfully",
  "data": {
    "id": "274fc73cb7d84a17955914fdc1a1f9d0",
    "wasUpdated": false
  }
}

Notas sobre la respuesta

  • wasUpdated: false indica que se creó un cliente nuevo
  • wasUpdated: true indica que ya existía un cliente con ese teléfono y fue actualizado en lugar de crear uno nuevo