Eliminar una serie

DELETE /api/v1/series/{seriesId} Elimina la serie, sus versiones, sus pasos y sus conexiones. Definitivo. Las campañas ya enviadas por sus pasos no se eliminan: salieron, tienen estadísticas y forman parte de tu historial.

Autorización

RolAcceso
OWNERPermitido
ADMINPermitido
MEMBERRechazado — 403

Parámetros de ruta

ParámetroTipoDescripción
seriesIdstring (uuid)El id de la serie

Ejemplo

bash
curl -s -X DELETE 'https://www.agentsmail.io/api/v1/series/7d7d7d7d-8888-4ccc-9ddd-eeee00001111' \
  -H "x-api-key: $AGENTMAIL_API_KEY"

Respuesta

CódigoCuándo
200Eliminada
400Este id es una secuencia, no una serie
401Clave ausente o no válida
403El rol de la clave es MEMBER
404No hay ninguna serie con este id en tu organización

Campos de la respuesta

CampoTipoDescripción
successbooleanSiempre true aquí
data.idstringEl id que se eliminó

Ejemplo de respuesta

json
{"success": true, "data": {"id": "7d7d7d7d-8888-4ccc-9ddd-eeee00001111"}}

Notas

Pausa primero la serie si está en marcha. Una serie eliminada deja de producir campañas de inmediato.

Relacionado