DELETE /api/v1/series/{seriesId}
Deletes the series, its versions, its steps and its wires. Definitive.
Campaigns already sent by its steps are not deleted: they went out, they have statistics, and
they belong to your history.
Authorization
| Role | Access |
|---|---|
OWNER | Allowed |
ADMIN | Allowed |
MEMBER | Refused — 403 |
Path parameters
| Parameter | Type | Description |
|---|---|---|
seriesId | string (uuid) | The series id |
Example
bash
curl -s -X DELETE 'https://www.agentsmail.io/api/v1/series/7d7d7d7d-8888-4ccc-9ddd-eeee00001111' \
-H "x-api-key: $AGENTMAIL_API_KEY"Response
| Code | When |
|---|---|
200 | Deleted |
400 | This id is a sequence, not a series |
401 | Missing or invalid key |
403 | The key's role is MEMBER |
404 | No series with this id in your organization |
Response fields
| Field | Type | Description |
|---|---|---|
success | boolean | Always true here |
data.id | string | The id that was deleted |
Example response
json
{"success": true, "data": {"id": "7d7d7d7d-8888-4ccc-9ddd-eeee00001111"}}