Rotate a voice agent's signing secret

Generates a new signing_secret for the agent and returns it. The previous secret stops signing immediately, so update your agent before the next call reaches it.

With sandbox: true a secret is generated and returned with 202, and nothing is written.

POST
/v3/voice/agents/{id}/rotate-secret

Path Parameters

id*string

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

Header Parameters

Idempotency-Key?string

Unique key to ensure idempotent request processing. Must be 1-255 alphanumeric characters, hyphens, or underscores. Responses are cached for 24 hours per key per customer.

Match^[a-zA-Z0-9_-]+$
Lengthlength <= 255
x-profile-id?string

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.

Formatuuid

Request Body

application/json
  1. body

Base request for mutation operations (POST, PUT, PATCH) with sandbox mode support

sandbox?boolean

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

Response Body

The new secret. The old one no longer signs anything

application/json
  1. response

Standard API response envelope for all v3 endpoints

success?boolean

Indicates whether the request was successful

data?|null

The response data (null if error)

error?|null

Error details (null if successful)

meta?

Metadata about the request and response

Example Request
curl -X POST 'https://api.sent.dm/v3/voice/agents/string/rotate-secret' \  -H 'Idempotency-Key: req_abc123_retry1' \  -H 'Content-Type: application/json' \  -d '{}'
Example Response
{  "success": true,  "data": {    "signing_secret": "whsec_MDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDA="  },  "error": null,  "meta": {    "request_id": "req_7X9zKp2jDw",    "timestamp": "2026-11-12T15:32:26.4813882+00:00",    "version": "v3"  }}