curl --request DELETE \
--url https://api.omni.z-api.io/v1/channels/{channelId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"cancelReason": "El cliente cerró la empresa"
}
'Canales
Eliminar canal
Elimina permanentemente un canal mediante la API
DELETE
/
v1
/
channels
/
{channelId}
curl --request DELETE \
--url https://api.omni.z-api.io/v1/channels/{channelId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"cancelReason": "El cliente cerró la empresa"
}
'Conceptos
Elimina permanentemente un canal y todos sus datos. El borrado es irreversible: el canal se elimina físicamente del sistema.Condiciones para eliminar
Solo se permite eliminar el canal cuando no tiene una suscripción activa. La siguiente tabla describe el comportamiento según el estado:| Estado | ¿Se permite eliminar? | Observación |
|---|---|---|
| Prueba | Sí | — |
| Pendiente | Sí | Si hay una factura abierta, se cancelará automáticamente |
| Pagado | No | El canal debe cancelarse antes de eliminarlo |
| En proceso de cancelación | No | El canal debe cancelarse antes de eliminarlo |
| Cancelado | Sí | — |
El borrado es permanente e irreversible. Para eliminar un canal con suscripción activa, primero cancela la suscripción con Cancelar suscripción y espera a que el estado sea
CANCELED.El
channelId se obtiene a través del endpoint Crear canal.Autorizaciones
Secret Key generada en el panel de Seguridad de Omni Z-API
Parámetros de ruta
ID del canal (obtenido con Crear canal)
Ejemplo:
"019E4C54B1B375A28970B605CA9B03C3"
Cuerpo
application/json
Motivo de la eliminación (opcional, pero recomendado con fines de auditoría)
Ejemplo:
"El cliente cerró la empresa"
Respuesta
Canal eliminado correctamente. No se devuelve contenido.