TelephonyCampaigns
Delete a telephony campaign
Deletes a terminal Campaign and its recipient/task data asynchronously. Returns bodyless 202 with a monitor, not a tombstone; completion makes GET return 404 and lists omit it. Dataset, connections, Agent, independent jobs and call history are preserved.
Header parameters
Foundry-Features
enum
required
A feature flag opt-in required when using preview operations or modifying persisted preview resources.
If-Match
string
required
Exact current token; no wildcards. Without replay, absent Campaigns return 204 and stale tokens 412. Active calls/workers or unfinished cancellation return 409.
Operation-Id
string
Optional retry key. Original If-Match/key replays 202 even after deletion/name reuse, never touching a new instance; conflicts return 409. Failed cleanup needs a fresh key/current token.
Path parameters
agent_name
string
required
Owning Agent; never overridden in recipient inputs.
campaign_name
string
required
Immutable Campaign name.
Query parameters
api-version
string
required
The API version to use for this operation.
Responses
The request has been accepted for processing, but processing has not yet completed.
Headers
Cache-Control
enum
required
Prevents caches from treating the control token as a validator for changing progress.
Operation-Location
string
required
Absolute deletion-monitor URI including api-version, retained after the Campaign is removed.
Operation-Id
string
required
Immutable deletion-operation ID; retries of the same accepted request return the same ID.
Retry-After
integer
required
Suggested delay in seconds before polling.
Request
DELETE /agents/{agent_name}/telephony_campaigns/{campaign_name} HTTP/1.1
Response
Status: 202
Status: 204
Status: 4XX
Content-Type: application/json
Status: 5XX
Content-Type: application/json