Desprogramar una campaña

DELETE /api/v1/campaigns/{campaignId}/schedule Cancela un envío reservado: una campaña scheduled, o paused que aún tiene fecha, vuelve a draft, sin fecha. El horario reservado deja de valer, y la campaña no saldrá hasta que la envíes o la vuelvas a programar.

Autorización

Rol en la organización	Este endpoint
`OWNER`	Permitido
`ADMIN`	Permitido
`MEMBER`	Rechazado — `403`

Una clave lleva el rol que su creador tiene en esta organización, nunca un rol en AgentsMail en sí. Consulta Claves de API.

Parámetros de ruta

Parámetro	Tipo	Descripción
`campaignId`	string	Identificador único de una campaña

Ejemplo

bash

curl -X DELETE -H "x-api-key: $AGENTMAIL_API_KEY" \
  "https://www.agentsmail.io/api/v1/campaigns/$CAMPAIGN_ID/schedule"

Respuesta

200 OK: la campaña ha vuelto a draft.
401 Unauthorized: clave ausente o no válida, o su propietario dejó la organización.
403 Forbidden: el propietario de la clave es member de la organización, no admin.
404 Not Found: no existe esa campaña, o pertenece a otra organización.
409 Conflict: la campaña no está programada (borrador, ya enviándose, enviada…), o cambió entre tu lectura y esta llamada. No se escribe nada.
429 Too Many Requests: más de 120 solicitudes en un minuto para esta clave.

Campos de la respuesta

Campo	Tipo	Descripción
`success`	boolean	Indica si la operación tuvo éxito
`data.campaignId`	string	La campaña desprogramada
`data.status`	string	Siempre `draft`

Ejemplo de respuesta

json

{
  "success": true,
  "data": {"campaignId": "6c6c6c6c-5555-4aaa-8bbb-999900001111", "status": "draft"}
}

Notas

Tarde es tarde: una vez la campaña está sending, responde 409 y el envío continúa.
Para mover una salida en lugar de cancelarla, vuelve a llamar a Programar una campaña; no hace falta desprogramar antes.