curl --request DELETE \
--url https://api.omni.z-api.io/v1/channels/{channelId}/cancel \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"cancelReason": "El cliente cerró la empresa"
}
'{
"error": 400,
"message": "cancel query param is required"
}{
"error": 401,
"message": "Unauthorized"
}{
"error": 404,
"message": "Channel not found"
}{
"error": 422,
"message": "This action requires ENTERPRISE role"
}Canales
Cancelar suscripción
Cancela la suscripción de un canal de forma programática
DELETE
/
v1
/
channels
/
{channelId}
/
cancel
curl --request DELETE \
--url https://api.omni.z-api.io/v1/channels/{channelId}/cancel \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"cancelReason": "El cliente cerró la empresa"
}
'{
"error": 400,
"message": "cancel query param is required"
}{
"error": 401,
"message": "Unauthorized"
}{
"error": 404,
"message": "Channel not found"
}{
"error": 422,
"message": "This action requires ENTERPRISE role"
}Conceptos
Solicita la cancelación de la suscripción de un canal. La cancelación no es inmediata: el canal pasa al estadoCANCELLATION_PROCESS y sigue activo hasta el final del periodo ya pagado. Transcurrido ese periodo, el estado cambia a CANCELED.
El parámetro de query cancel=true es obligatorio, como confirmación explícita de la cancelación.
El campo cancelReason del body es opcional, pero se recomienda incluirlo con fines de auditoría.
Estados después de la cancelación
| Estado | Descripción |
|---|---|
CANCELLATION_PROCESS | Cancelación solicitada; el canal sigue activo hasta el final del periodo |
CANCELED | Canal cancelado y desactivado de forma efectiva |
La cancelación no se puede deshacer mediante la API. Para reactivar el canal hay que iniciar una nueva suscripción con Suscribir canal.
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"
Parámetros de consulta
Debe ser true para confirmar la cancelación
Ejemplo:
true
Cuerpo
application/json
Motivo de la cancelación (opcional, pero recomendado con fines de auditoría)
Ejemplo:
"El cliente cerró la empresa"
Respuesta
Cancelación solicitada correctamente. No se devuelve contenido.