API ReferenceContacts

Rotate Contact Resolver Secret

Beta

Mint a new signing secret for the workspace’s resolver and return it once. The previous secret stops signing immediately, so deploy the new one to your verifier before rotating - a request your endpoint cannot verify should be rejected, and a rejected resolver call degrades to a call with no contact.

Authentication

AuthorizationBearer

Enter your API key with the Bearer prefix, e.g. ‘Bearer sk_…’.

Headers

Speechify-VersionstringOptional

Response headers

Speechify-Request-IdstringOptional
Unique identifier for this request, present on every response (2xx and non-2xx alike). If the caller sends a `Speechify-Request-Id` request header the server echoes it back (sanitized and length-capped) so one logical request can be traced end-to-end; otherwise the server generates a fresh value. Log it on every response and quote it in support requests - it is the stable handle that ties your observation to Speechify's server-side logs, and it matches the `request_id` field in the error envelope. The legacy alias `X-Request-ID` carries the same value and is still accepted on requests, until 2027-07-24. Prefer the un-prefixed name (RFC 6648).

Response

The configuration carrying the new secret (shown once).

urlstringformat: "uri"
The HTTPS endpoint Speechify POSTs the identifier to.
disabledboolean
When true the endpoint is kept but never called, which is how you park an integration without losing its secret.
created_atdatetime
updated_atdatetime
secretstringOptional

The HMAC signing key, present ONLY in the response that mints it (first configuration, or a rotation). Verify Speechify-Signature with it exactly as you would a webhook.

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error