SEsentdm
Voice

Delete a voice agent

Changed on

Removes the agent. Calls it already took keep their agent_id.

An agent that one of your voice numbers routes to, or that another of your agents lists in transfer_targets, is not deleted: the answer is 409 with a message naming those numbers and agents. Unbind the numbers (PATCH /v3/channels/voice/{number} with "agent_id": null), take the agent out of the others' transfer_targets or delete them, and try again.

With sandbox: true nothing is written: the agent is looked up and the answer is the one a real delete would give.

delete/v3/voice/agents/{id}

Request

  • Base URL
    https://api.sent.dm
  • URL
    https://api.sent.dm/v3/voice/agents/{id}
  • Auth
    • API key in header x-api-key
    • or HTTP bearer

Path parameters

idstring required

The agent id, such as agent_9f2ab000-0000-4000-8000-000000000001

Headers

x-profile-idstring uuid

Profile UUID to scope the request to a child profile. Only organization API keys can use this header. The profile must belong to the calling organization.

Request body

sandboxboolean

Sandbox flag - when true, the operation is simulated without side effects Useful for testing integrations without actual execution

Response

Deleted

Changes