Update an account, or rotate its carrier credentials
const url = 'https://api.vocapable.com/v1/telephony-accounts/example';const options = { method: 'PATCH', headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'}, body: '{"credentials":{"account_sid":"example","auth_token":"example"},"a2p_brand_ref":"example","ftc_san_refs":[{"san":"example","area_codes":["example"]}]}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request PATCH \ --url https://api.vocapable.com/v1/telephony-accounts/example \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "credentials": { "account_sid": "example", "auth_token": "example" }, "a2p_brand_ref": "example", "ftc_san_refs": [ { "san": "example", "area_codes": [ "example" ] } ] }'Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”Request Bodyrequired
Section titled “Request Bodyrequired”Partial update. Rotation is this request carrying a fresh credential pair.
object
Carrier credentials on their way to the vault. Never present on a response.
SecretStr so a body that reaches a log line, a traceback, or a validation error
renders as ********** rather than a usable secret (docs/10-security.md §secrets).
The two fields are the incumbent’s credential pair, and pinning them here is deliberate: the vault beneath stores an arbitrary flat map and the account row holds an opaque text reference, so a second carrier’s credential shape is a change to this model plus its readers - a contracts change, never a migration (ADR-0030 decision 8).
object
One FTC Subscription Account Number and the area codes it covers (CANON fact 5).
object
Examplegenerated
{ "credentials": { "account_sid": "example", "auth_token": "example" }, "a2p_brand_ref": "example", "ftc_san_refs": [ { "san": "example", "area_codes": [ "example" ] } ]}Responses
Section titled “Responses”Successful Response
An account as its tenant sees it - credential material is structurally absent.
object
One FTC Subscription Account Number and the area codes it covers (CANON fact 5).
object
Example
{ "mode": "byo", "verification_status": "pending"}Validation Error
object
object
object
Examplegenerated
{ "detail": [ { "loc": [ "example" ], "msg": "example", "type": "example", "input": "example", "ctx": {} } ]}