Skip to main content
DELETE
cURL

Authorizations

Authorization
string
header
required

Send your API key as Authorization: Bearer YOUR_API_KEY.

Path Parameters

id
string
required

Agent id.

Minimum string length: 1

Query Parameters

cascade
enum<string>
required

Required for public API deletes. Soft-deletes the Agent aggregate, including its campaign, workflow ownership, and master-project campaign bindings. External voice resources are preserved for recovery.

Available options:
agent_and_campaign

Response

Agent soft-deleted.

success
boolean
required
deleted
boolean
required
deletedCampaign
boolean

Whether campaign state was soft-deleted as part of the aggregate deletion.

Example:

true

deletedAgent
boolean

Whether the Agent aggregate root was soft-deleted.

Example:

true

deletedCampaigns
integer

Number of physical campaign or project-binding rows soft-deleted behind the aggregate.

Required range: x >= 0
Example:

1