Ricky logorickyDocs

Cancelar una campaña programada

POST
/broadcasts/{broadcast_id}/cancel

Cancela una campaña scheduled antes de que empiece; no se envía nada. Si ya está queued o enviándose, o ya se canceló, responde 409 conflict. No envíes cuerpo.

Permiso: broadcasts:write.

Autorización

bearerAuth
headerAuthorizationBearer <clave>

Una clave de API de la organización, rky_live_…, creada en Configuración → API. Envíala solo desde un servidor.

Parámetros de ruta

broadcast_id*string

ID de la campaña.

Formatouuid

Parámetros de cabecera

Idempotency-Key?string

Opcional. Un valor que eliges, único por escritura lógica, de 8 a 200 caracteres: un UUID o un ID de tu sistema, como order-10482-ready. Reintentar con la misma clave y el mismo cuerpo repite la primera respuesta en lugar de repetir la escritura.

Longitud8 <= length <= 200

Cuerpo de la respuesta

Éxito.

application/json
  1. response
data*

Una plantilla aprobada de WhatsApp enviada a muchos números.

curl -X POST 'https://getricky.ai/api/v1/broadcasts/497f6eca-6276-4993-bfeb-53cbbbba6f08/cancel' \  -H 'Idempotency-Key: order-10482-ready'
{  "data": {    "id": "0c1d2e3f-4a5b-4c6d-8e7f-9a0b1c2d3e4f",    "channel_id": "8f3c2a5e-6b1d-4c7a-9e2f-1a2b3c4d5e6f",    "template": {      "id": "1234567890123456",      "name": "promo_octubre",      "language": "es"    },    "audience": {      "type": "filter",      "tag_id": "5c6d7e8f-9a0b-4c1d-8e2f-3a4b5c6d7e8f",      "lifecycle_stage": null,      "query": null    },    "status": "completed",    "counts": {      "recipients": 120,      "pending": 0,      "sent": 14,      "delivered": 61,      "read": 41,      "failed": 4    },    "scheduled_at": "2026-10-14T14:00:00.000Z",    "canceled_at": null,    "completed_at": "2026-10-14T14:03:12.000Z",    "created_by_user_id": "2d4f6a8c-1b3d-4e5f-8a7b-9c0d1e2f3a4b",    "created_at": "2026-10-14T15:30:00.000Z"  }}