Referencia de la APIContactos
Editar
Actualiza parcialmente un contacto de un cliente.
Descripción general
Este endpoint actualiza parcialmente un contacto. Todos los campos del cuerpo son opcionales:
- Omitido → el campo conserva su valor actual.
null→ el campo se limpia.nameno se puede limpiar.
La API combina tus cambios con los datos guardados del contacto y valida el resultado completo. El contacto debe pertenecer al cliente de la URL; si pertenece a otro cliente, la API responde 404. Una solicitud exitosa devuelve 200 con el contacto completo.
Requiere el permiso Administrar en Clientes.
Endpoint
PATCH
https://app.credonix.mx/api/v1/customers/{customerId}/contacts/{contactId}Path params:
customerId— eliddel cliente.contactId— eliddel contacto.
Limpiar un campo
Envía el campo en null para limpiarlo. El resto del contacto queda intacto.
{ "phone": null }Campos del cuerpo
| Campo | Tipo | Notas |
|---|---|---|
name | string | No puede ser vacío. |
email, second_email | string | null | Correo válido, "" o null. |
phone, second_phone | string | null | Teléfono válido en formato internacional, "" o null. |
No se aceptan campos adicionales.
Errores
404 — contacto de otro cliente
{
"code": "NOT_FOUND",
"message": "El contacto no fue encontrado.",
"request_id": "d593af0c-4eaf-4a4c-8817-1d843a90d31c"
}| Status | Código | Causa |
|---|---|---|
400 | VALIDATION_ERROR | El cuerpo no es un objeto JSON, un campo tiene formato inválido o se envió un campo desconocido. |
403 | INSUFFICIENT_PERMISSIONS | La API key no tiene el permiso Administrar en Clientes. |
404 | NOT_FOUND | El contacto no existe o no pertenece a ese cliente. Se valida antes que el cuerpo. |