Skip to main content
DELETE
Delete Campaign

Delete Campaign

Delete a campaign and its recipient links. This only works if no values have been submitted.
This action cannot be undone. If the campaign has submitted values, the API returns 409 Conflictlock the campaign instead.

Request

Headers

string
required
Your API key for authenticationExample: sk_live_1234567890abcdef
string
required
Your organization UUIDExample: a8315ef3-dd50-43f8-b7ce-d839e68d51fa

Path Parameters

string
required
UUID of the parent dataset
string
required
UUID of the campaign to delete

Response

Returns HTTP 204 No Content on success.

Example

Common Errors

401 Unauthorized

Cause: Missing or invalid API key

403 Forbidden

Cause: The authenticated user is not a member of the organization

404 Not Found

Cause: Campaign not found

409 Conflict

Cause: Campaign has submitted values

Lock Campaign

Lock instead of deleting

List Campaigns

View all campaigns