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 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 un canal. Una vez eliminado, el canal ya no se puede usar, y el borrado no se puede deshacer mediante la API.Condiciones para eliminar
Solo se permite eliminar el canal cuando está desconectado y no tiene una suscripción activa. Si el canal sigue conectado, la API responde422 con INSTANCE_STILL_CONNECTED. 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 no se puede deshacer mediante la API. 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.Error 502
Si el borrado falla en el servicio interno, la API responde 502 con el cuerpo siguiente, sin detalles internos. Inténtalo de nuevo y, si el error persiste, contacta con soporte.
{
"error": "integration_unavailable",
"message": "The operation could not be completed right now. Try again in a few moments."
}
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.