DELETE
/v1/campaigns/:idDelete campaign
Deletes a single campaign you own. By default its leads are deleted too; pass ?keepLeads=true to migrate them to your unassigned leads list instead.
Request
| Authorization | Bearer YOUR_API_KEY |
Parameters
| Field | Type | Required | Description |
|---|---|---|---|
| id | string | Required | Campaign ID. |
| keepLeads | boolean | Optional | true to keep the campaign's leads (moved to the unassigned leads list) instead of deleting them. |
curl -X DELETE "https://api.stynar.com/v1/campaigns/cmp_abc123?keepLeads=true" \
-H "Authorization: Bearer esk_your_key_here"Response
✓ 200 OK
200 response
{
"campaignId": "cmp_abc123",
"leadsDeleted": 0
}Response fields
Errors
| Status | Code | Meaning |
|---|---|---|
| ✕ 404 Not Found | NOT_FOUND | Campaign doesn't exist or isn't yours. |
| ✕ 401 Unauthorized | UNAUTHORIZED | Missing, malformed, unknown, revoked, or expired key. |
| ✕ 403 Forbidden | API_ACCESS_DISABLED | Your account doesn't currently have API access. |
| ✕ 403 Forbidden | INSUFFICIENT_SCOPE | The key doesn't have the scope this endpoint requires. |
| ✕ 404 Not Found | NOT_FOUND | Unknown route, or a resource that doesn't exist / isn't yours. |
| ✕ 409 Conflict | CONFLICT | The action can't be applied to the resource's current state. |
| ✕ 429 Too Many Requests | RATE_LIMIT_EXCEEDED | Per-minute or per-second limit hit. |
| ✕ 429 Too Many Requests | QUOTA_EXCEEDED | Monthly quota exhausted. |
| ✕ 500 Internal Server Error | INTERNAL_ERROR | Something broke on Stynar's end. |