Accounts

API reference descriptions are provided in English to preserve the exact published contract.

GETGet the authenticated accountaccounts.retrieve
PATCHUpdate the authenticated accountaccounts.update
GETList API date versions and the account defaultapiVersions.list
PATCHSet the account default API versionapiVersions.default.update
POSTIrreversibly close the authenticated accountclose.create
GETRead current legal documents and organization acceptancelegalAcceptance.list
POSTAffirmatively accept exact current organization legal documentslegalAcceptance.create
GETGet the account's allowed-country policymessagingPolicy.list
PUTSet the account's allowed-country policymessagingPolicy.update
GETGet the owning organizationorganization.list
PATCHUpdate the owning organizationorganization.update
GETList organization accountsorganization.accounts.list
POSTCreate an account in the organizationorganization.accounts.create
POSTIrreversibly close the organizationorganization.close
GETRead customer key custody configuration and verification statesecurity.customerKms.list
POSTConfigure approved customer OpenBao Transit custodysecurity.customerKms.create
POSTActivate approved customer key custody after verificationsecurity.customerKms.activate
POSTStart approved customer key custody rotationsecurity.customerKms.start
GETShow the account data encryption key version and its last rotationsecurity.keys.list
POSTRotate the account data encryption key (new Transit key version)security.keys.rotate
GETList subaccountssubaccounts.list
POSTCreate a subaccountsubaccounts.create
GETGet a subaccountsubaccounts.retrieve
PATCHUpdate a subaccountsubaccounts.update
DELETEClose an empty subaccountsubaccounts.delete
GETPublic API changelog feedchangelog.list
GETPublic API changelog feed as RSS 2.0changelogRss.list

Get the authenticated account

GET/v1/accounts/{AC}

accounts.retrieveSDK operation getV1AccountsByAc

Required scope: accounts:read.

GET /v1/accounts/{AC}

curl "https://api.staging.toutye.com/v1/accounts/$TOUTYE_ACCOUNT_SID" \
  -H "Authorization: Bearer $TOUTYE_API_KEY" \
  -H "Toutye-Version: 2026-08-21"

Responses

Update the authenticated account

PATCH/v1/accounts/{AC}

accounts.updateSDK operation patchV1AccountsByAc

Required scope: accounts:write.Idempotency-Key required

Request body

reasonstring (max 2000 chars)Required
autoReadReceiptsboolean
consentPolicyenum
STRICTSTANDARD
displayNamestring (max 128 chars)
homeRegionstring (pattern ^[a-z0-9][a-z0-9-]*$, max 64 chars)
timezonestring (max 64 chars) | null
IANA time zone the account schedules in (for example Africa/Lagos). null returns to the zone of the organization's country.

PATCH /v1/accounts/{AC}

curl -X PATCH "https://api.staging.toutye.com/v1/accounts/$TOUTYE_ACCOUNT_SID" \
  -H "Authorization: Bearer $TOUTYE_API_KEY" \
  -H "Toutye-Version: 2026-08-21" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
  "reason": "string"
}'

Responses

List API date versions and the account default

GET/v1/accounts/{AC}/api-versions

apiVersions.listSDK operation getV1AccountsByAcApiVersions

The version registry: known dates, their status and their end-of-support dates, together with this account's default and the version this request resolved to.

Required scope: accounts:read.

GET /v1/accounts/{AC}/api-versions

curl "https://api.staging.toutye.com/v1/accounts/$TOUTYE_ACCOUNT_SID/api-versions" \
  -H "Authorization: Bearer $TOUTYE_API_KEY" \
  -H "Toutye-Version: 2026-08-21"

Responses

Set the account default API version

PATCH/v1/accounts/{AC}/api-versions/default

apiVersions.default.updateSDK operation patchV1AccountsByAcApiVersionsDefault

: the per-account default a request without Toutye-Version resolves to. null restores the platform default. A sunset or unknown date is refused.

Required scope: any one of accounts:write, api_keys:write.Idempotency-Key required

Request body

versionstring (pattern ^\d{4}-\d{2}-\d{2}$) | nullRequired

PATCH /v1/accounts/{AC}/api-versions/default

curl -X PATCH "https://api.staging.toutye.com/v1/accounts/$TOUTYE_ACCOUNT_SID/api-versions/default" \
  -H "Authorization: Bearer $TOUTYE_API_KEY" \
  -H "Toutye-Version: 2026-08-21" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
  "version": "string"
}'

Responses

Irreversibly close the authenticated account

POST/v1/accounts/{AC}/close

close.createSDK operation postV1AccountsByAcClose

Required scope: organization:delete.Idempotency-Key required

Request body

caseRefstring (max 128 chars)Required
confirmationstring (max 28 chars)Required
reasonstring (max 2000 chars)Required
stepUpTokenstring (max 256 chars)Required

POST /v1/accounts/{AC}/close

curl -X POST "https://api.staging.toutye.com/v1/accounts/$TOUTYE_ACCOUNT_SID/close" \
  -H "Authorization: Bearer $TOUTYE_API_KEY" \
  -H "Toutye-Version: 2026-08-21" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
  "caseRef": "string",
  "confirmation": "string",
  "reason": "string",
  "stepUpToken": "string"
}'

Responses

Read current legal documents and organization acceptance

GET/v1/accounts/{AC}/legal-acceptance

legalAcceptance.listSDK operation getV1AccountsByAcLegalAcceptance

Required scope: accounts:read.

GET /v1/accounts/{AC}/legal-acceptance

curl "https://api.staging.toutye.com/v1/accounts/$TOUTYE_ACCOUNT_SID/legal-acceptance" \
  -H "Authorization: Bearer $TOUTYE_API_KEY" \
  -H "Toutye-Version: 2026-08-21"

Responses

Affirmatively accept exact current organization legal documents

POST/v1/accounts/{AC}/legal-acceptance

legalAcceptance.createSDK operation postV1AccountsByAcLegalAcceptance

Required scope: accounts:write.Idempotency-Key required

Request body

manifestHashstring (pattern ^[0-9a-f]{64}$)Required
privacyNoticeAcknowledgedtrueRequired
termsAcceptedtrueRequired
versionstring (pattern ^20[0-9]{2}-[0-9]{2}-[0-9]{2}$)Required

POST /v1/accounts/{AC}/legal-acceptance

curl -X POST "https://api.staging.toutye.com/v1/accounts/$TOUTYE_ACCOUNT_SID/legal-acceptance" \
  -H "Authorization: Bearer $TOUTYE_API_KEY" \
  -H "Toutye-Version: 2026-08-21" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
  "manifestHash": "string",
  "privacyNoticeAcknowledged": "string",
  "termsAccepted": "string",
  "version": "string"
}'

Responses

Get the account's allowed-country policy

GET/v1/accounts/{AC}/messaging-policy

messagingPolicy.listSDK operation getV1AccountsByAcMessagingPolicy

allowedCountries null means every country may be messaged (the default). A send to a phone number in a country outside the list is refused with MARKET_EXCLUDED.

Required scope: accounts:read.

GET /v1/accounts/{AC}/messaging-policy

curl "https://api.staging.toutye.com/v1/accounts/$TOUTYE_ACCOUNT_SID/messaging-policy" \
  -H "Authorization: Bearer $TOUTYE_API_KEY" \
  -H "Toutye-Version: 2026-08-21"

Responses

Set the account's allowed-country policy

PUT/v1/accounts/{AC}/messaging-policy

messagingPolicy.updateSDK operation putV1AccountsByAcMessagingPolicy

ISO 3166-1 alpha-2 codes. An empty list or null removes the restriction. Send admission applies it to every later message to a phone number from this scope.

Required scope: accounts:write.Idempotency-Key required

Request body

allowedCountriesstring (pattern ^[A-Za-z]{2}$)[] | nullRequired

PUT /v1/accounts/{AC}/messaging-policy

curl -X PUT "https://api.staging.toutye.com/v1/accounts/$TOUTYE_ACCOUNT_SID/messaging-policy" \
  -H "Authorization: Bearer $TOUTYE_API_KEY" \
  -H "Toutye-Version: 2026-08-21" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
  "allowedCountries": "string"
}'

Responses

Get the owning organization

GET/v1/accounts/{AC}/organization

organization.listSDK operation getV1AccountsByAcOrganization

Required scope: users:read.Paginated

Parameters

limitinteger (1–100)query
cursorstring (max 2048 chars)query

GET /v1/accounts/{AC}/organization

curl "https://api.staging.toutye.com/v1/accounts/$TOUTYE_ACCOUNT_SID/organization" \
  -H "Authorization: Bearer $TOUTYE_API_KEY" \
  -H "Toutye-Version: 2026-08-21"

Responses

Update the owning organization

PATCH/v1/accounts/{AC}/organization

organization.updateSDK operation patchV1AccountsByAcOrganization

Required scope: accounts:write.Idempotency-Key required

Request body

reasonstring (max 2000 chars)Required
countrystring (pattern ^[A-Z]{2}$)
defaultCurrencystring (pattern ^[A-Z]{3}$)
displayNamestring (max 128 chars)
legalNamestring (max 200 chars)

PATCH /v1/accounts/{AC}/organization

curl -X PATCH "https://api.staging.toutye.com/v1/accounts/$TOUTYE_ACCOUNT_SID/organization" \
  -H "Authorization: Bearer $TOUTYE_API_KEY" \
  -H "Toutye-Version: 2026-08-21" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
  "reason": "string"
}'

Responses

List organization accounts

GET/v1/accounts/{AC}/organization/accounts

organization.accounts.listSDK operation getV1AccountsByAcOrganizationAccounts

Required scope: accounts:read.Paginated

Parameters

limitinteger (1–100)query
cursorstring (max 2048 chars)query

GET /v1/accounts/{AC}/organization/accounts

curl "https://api.staging.toutye.com/v1/accounts/$TOUTYE_ACCOUNT_SID/organization/accounts" \
  -H "Authorization: Bearer $TOUTYE_API_KEY" \
  -H "Toutye-Version: 2026-08-21"

Responses

Create an account in the organization

POST/v1/accounts/{AC}/organization/accounts

organization.accounts.createSDK operation postV1AccountsByAcOrganizationAccounts

Required scope: organization:write.Idempotency-Key required

Request body

displayNamestring (max 128 chars)Required
homeRegionstring (pattern ^[a-z0-9][a-z0-9-]*$, max 64 chars)Required
reasonstring (max 2000 chars)Required

POST /v1/accounts/{AC}/organization/accounts

curl -X POST "https://api.staging.toutye.com/v1/accounts/$TOUTYE_ACCOUNT_SID/organization/accounts" \
  -H "Authorization: Bearer $TOUTYE_API_KEY" \
  -H "Toutye-Version: 2026-08-21" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
  "displayName": "string",
  "homeRegion": "string",
  "reason": "string"
}'

Responses

Irreversibly close the organization

POST/v1/accounts/{AC}/organization/close

organization.closeSDK operation postV1AccountsByAcOrganizationClose

Required scope: organization:delete.Idempotency-Key required

Request body

caseRefstring (max 128 chars)Required
confirmationstring (max 28 chars)Required
reasonstring (max 2000 chars)Required
stepUpTokenstring (max 256 chars)Required

POST /v1/accounts/{AC}/organization/close

curl -X POST "https://api.staging.toutye.com/v1/accounts/$TOUTYE_ACCOUNT_SID/organization/close" \
  -H "Authorization: Bearer $TOUTYE_API_KEY" \
  -H "Toutye-Version: 2026-08-21" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
  "caseRef": "string",
  "confirmation": "string",
  "reason": "string",
  "stepUpToken": "string"
}'

Responses

Read customer key custody configuration and verification state

GET/v1/accounts/{AC}/security/customer-kms

security.customerKms.listSDK operation getV1AccountsByAcSecurityCustomerKms

Required scope: accounts:read.

GET /v1/accounts/{AC}/security/customer-kms

curl "https://api.staging.toutye.com/v1/accounts/$TOUTYE_ACCOUNT_SID/security/customer-kms" \
  -H "Authorization: Bearer $TOUTYE_API_KEY" \
  -H "Toutye-Version: 2026-08-21"

Responses

Configure approved customer OpenBao Transit custody

POST/v1/accounts/{AC}/security/customer-kms

security.customerKms.createSDK operation postV1AccountsByAcSecurityCustomerKms

Required scope: accounts:write.Idempotency-Key required

Request body

addressstring (max 500 chars)Required
approvalSidstring (AP… SID)Required
mountstring (max 128 chars)Required
provider"CUSTOMER_OPENBAO_TRANSIT"Required
stepUpTokenstring (max 256 chars)Required
tokenSecretRefstring (max 500 chars)Required
namespacestring (max 128 chars)

POST /v1/accounts/{AC}/security/customer-kms

curl -X POST "https://api.staging.toutye.com/v1/accounts/$TOUTYE_ACCOUNT_SID/security/customer-kms" \
  -H "Authorization: Bearer $TOUTYE_API_KEY" \
  -H "Toutye-Version: 2026-08-21" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
  "address": "string",
  "approvalSid": "AP...",
  "mount": "string",
  "provider": "CUSTOMER_OPENBAO_TRANSIT",
  "stepUpToken": "string",
  "tokenSecretRef": "string"
}'

Responses

Activate approved customer key custody after verification

POST/v1/accounts/{AC}/security/customer-kms/activate

security.customerKms.activateSDK operation postV1AccountsByAcSecurityCustomerKmsActivate

Required scope: accounts:write.Idempotency-Key required

Request body

approvalSidstring (AP… SID)Required
stepUpTokenstring (max 256 chars)Required

POST /v1/accounts/{AC}/security/customer-kms/activate

curl -X POST "https://api.staging.toutye.com/v1/accounts/$TOUTYE_ACCOUNT_SID/security/customer-kms/activate" \
  -H "Authorization: Bearer $TOUTYE_API_KEY" \
  -H "Toutye-Version: 2026-08-21" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
  "approvalSid": "AP...",
  "stepUpToken": "string"
}'

Responses

Start approved customer key custody rotation

POST/v1/accounts/{AC}/security/customer-kms/start

security.customerKms.startSDK operation postV1AccountsByAcSecurityCustomerKmsStart

Required scope: accounts:write.Idempotency-Key required

Request body

approvalSidstring (AP… SID)Required
stepUpTokenstring (max 256 chars)Required

POST /v1/accounts/{AC}/security/customer-kms/start

curl -X POST "https://api.staging.toutye.com/v1/accounts/$TOUTYE_ACCOUNT_SID/security/customer-kms/start" \
  -H "Authorization: Bearer $TOUTYE_API_KEY" \
  -H "Toutye-Version: 2026-08-21" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
  "approvalSid": "AP...",
  "stepUpToken": "string"
}'

Responses

Show the account data encryption key version and its last rotation

GET/v1/accounts/{AC}/security/keys

security.keys.listSDK operation getV1AccountsByAcSecurityKeys

Required scope: audit:read.

GET /v1/accounts/{AC}/security/keys

curl "https://api.staging.toutye.com/v1/accounts/$TOUTYE_ACCOUNT_SID/security/keys" \
  -H "Authorization: Bearer $TOUTYE_API_KEY" \
  -H "Toutye-Version: 2026-08-21"

Responses

Rotate the account data encryption key (new Transit key version)

POST/v1/accounts/{AC}/security/keys/rotate

security.keys.rotateSDK operation postV1AccountsByAcSecurityKeysRotate

Required scope: accounts:write.Idempotency-Key required

Request body

approvalSidstring (AP… SID)Required
reasonstring (max 2000 chars)Required
stepUpTokenstring (max 256 chars)Required
caseRefstring (max 128 chars)

POST /v1/accounts/{AC}/security/keys/rotate

curl -X POST "https://api.staging.toutye.com/v1/accounts/$TOUTYE_ACCOUNT_SID/security/keys/rotate" \
  -H "Authorization: Bearer $TOUTYE_API_KEY" \
  -H "Toutye-Version: 2026-08-21" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
  "approvalSid": "AP...",
  "reason": "string",
  "stepUpToken": "string"
}'

Responses

List subaccounts

GET/v1/accounts/{AC}/subaccounts

subaccounts.listSDK operation getV1AccountsByAcSubaccounts

Required scope: accounts:read.Paginated

Parameters

limitinteger (1–100)query
cursorstring (max 2048 chars)query

GET /v1/accounts/{AC}/subaccounts

curl "https://api.staging.toutye.com/v1/accounts/$TOUTYE_ACCOUNT_SID/subaccounts" \
  -H "Authorization: Bearer $TOUTYE_API_KEY" \
  -H "Toutye-Version: 2026-08-21"

Responses

Create a subaccount

POST/v1/accounts/{AC}/subaccounts

subaccounts.createSDK operation postV1AccountsByAcSubaccounts

Required scope: accounts:write.Idempotency-Key required

Request body

displayNamestring (max 128 chars)Required

POST /v1/accounts/{AC}/subaccounts

curl -X POST "https://api.staging.toutye.com/v1/accounts/$TOUTYE_ACCOUNT_SID/subaccounts" \
  -H "Authorization: Bearer $TOUTYE_API_KEY" \
  -H "Toutye-Version: 2026-08-21" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
  "displayName": "string"
}'

Responses

Get a subaccount

GET/v1/accounts/{AC}/subaccounts/{SA}

subaccounts.retrieveSDK operation getV1AccountsByAcSubaccountsBySa

Required scope: accounts:read.

Parameters

SAstring (SA… SID)Required

GET /v1/accounts/{AC}/subaccounts/{SA}

curl "https://api.staging.toutye.com/v1/accounts/$TOUTYE_ACCOUNT_SID/subaccounts/SA..." \
  -H "Authorization: Bearer $TOUTYE_API_KEY" \
  -H "Toutye-Version: 2026-08-21"

Responses

Update a subaccount

PATCH/v1/accounts/{AC}/subaccounts/{SA}

subaccounts.updateSDK operation patchV1AccountsByAcSubaccountsBySa

Required scope: accounts:write.Idempotency-Key required

Parameters

SAstring (SA… SID)Required

Request body

displayNamestring (max 128 chars)Required

PATCH /v1/accounts/{AC}/subaccounts/{SA}

curl -X PATCH "https://api.staging.toutye.com/v1/accounts/$TOUTYE_ACCOUNT_SID/subaccounts/SA..." \
  -H "Authorization: Bearer $TOUTYE_API_KEY" \
  -H "Toutye-Version: 2026-08-21" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
  "displayName": "string"
}'

Responses

Close an empty subaccount

DELETE/v1/accounts/{AC}/subaccounts/{SA}

subaccounts.deleteSDK operation deleteV1AccountsByAcSubaccountsBySa

Required scope: accounts:write.

Parameters

SAstring (SA… SID)Required

DELETE /v1/accounts/{AC}/subaccounts/{SA}

curl -X DELETE "https://api.staging.toutye.com/v1/accounts/$TOUTYE_ACCOUNT_SID/subaccounts/SA..." \
  -H "Authorization: Bearer $TOUTYE_API_KEY" \
  -H "Toutye-Version: 2026-08-21"

Responses

Public API changelog feed

GET/v1/changelog

changelog.listSDK operation getV1Changelog

Every known API date version with its release, deprecation and end-of-support dates, newest first. The same entries are published as RSS 2.0 at /v1/changelog.rss.

PaginatedNo key needed

Parameters

limitinteger (1–100)query
cursorstring (max 2048 chars)query

GET /v1/changelog

curl "https://api.staging.toutye.com/v1/changelog" \
  -H "Toutye-Version: 2026-08-21"

Responses

Public API changelog feed as RSS 2.0

GET/v1/changelog.rss

changelogRss.listSDK operation getV1ChangelogRss

No key needed

GET /v1/changelog.rss

curl "https://api.staging.toutye.com/v1/changelog.rss" \
  -H "Toutye-Version: 2026-08-21"

Responses