SEsentdm
Channels
Voice

Rotate a voice number's callback secret

Changed on

Generates a new signing secret for the questions Sent sends to this number's callback URL and returns it. The previous secret stops signing immediately, so update your backend before the next call reaches it. The number is the E.164 value in the path with the plus sign URL-encoded (%2B).

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

post/v3/channels/voice/{number}/rotate-secret

Request

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

Path parameters

numberstring required

The voice number from the route, in E.164 format with the plus sign URL-encoded (%2B), for example /v3/channels/voice/%2B12025550123/rotate-secret.

Headers

Idempotency-Keystring

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.

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

The new secret. The old one no longer signs anything

successboolean

Indicates whether the request was successful

Changes