CredonixDocs
Referencia de la APIClientes

Eliminar

Elimina un cliente y la información que depende de él.

Descripción general

Este endpoint elimina un cliente de forma definitiva. A partir de ese momento, GET, PATCH y DELETE sobre ese id responden 404.

El cliente se puede eliminar aunque tenga órdenes de cobro, pagos o saldo a favor. La respuesta exitosa es 204 No Content con cuerpo vacío.

Requiere el permiso Administrar en Clientes.

Endpoint

DELETEhttps://app.credonix.mx/api/v1/customers/{customerId}

Path param: customerId — el id del cliente.

Solicitud


Sin cuerpo. La API responde 204 No Content si el cliente se eliminó.

Comportamiento

Al eliminar el cliente también se eliminan:

  • Sus contactos.
  • Sus automatizaciones recurrentes, por calendario personalizado y por plan de proyecto, con su historial.
  • Sus movimientos de saldo a favor.
  • Su inclusión o exclusión en grupos de mensajes.

Sus órdenes de cobro se conservan: dejan de estar vinculadas al cliente, pero mantienen el alias, la razón social, el RFC, el régimen fiscal y el código postal que tenían.

El borrado del cliente y de cada automatización eliminada queda registrado en la actividad de la organización con el nombre de la API key.

Errores

StatusCódigoCausa
403INSUFFICIENT_PERMISSIONSLa API key no tiene el permiso Administrar en Clientes.
404NOT_FOUNDEl cliente no existe o ya fue eliminado. La respuesta incluye { "message": "Customer not found" }.
Abrir Credonix