Senders

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

GETList sender poolssenderPools.list
POSTCreate a sender poolsenderPools.create
GETFetch a sender poolsenderPools.retrieve
PATCHUpdate a sender poolsenderPools.update
DELETEDelete a sender poolsenderPools.delete
GETList WhatsApp senders and current provider readinesssenders.list
POSTSubscribe a WABA and register a Cloud API sendersenders.create
GETList provider storage regions permitted by this account's residency policysenders.storageRegions.list
GETFetch a WhatsApp sendersenders.retrieve
PATCHUpdate sender management settingssenders.update
DELETERemove a sender locally without changing Meta assetssenders.delete
POSTBlock WhatsApp userssenders.blockUsers
DELETEUnblock WhatsApp userssenders.blockUsers.delete
GETGet the current reconciled WhatsApp business profilesenders.businessProfile.list
PATCHCreate an Operation-backed WhatsApp business profile updatesenders.businessProfile.update
POSTDeregister a Cloud API sendersenders.deregister
POSTGenerate, upload and verify a sender Flow encryption keysenders.flows.keys
GETRead Managed business-name requestssenders.nameRequests.list
GETFetch sender opt-out keyword configurationsenders.optOutConfig.list
PUTReplace sender opt-out keyword configurationsenders.optOutConfig.update
GETRead retained sender quality transitionssenders.qualityHistory.list
POSTRotate the sender two-step verification PINsenders.twoStepPin
POSTRequest or submit a sender verification codesenders.verify
GETRead the phone-level webhook override of a sendersenders.webhookOverride.list
PATCHSet or clear the phone-level webhook override of a sendersenders.webhookOverride.update
POSTDisconnect a WABA and fence all of its senderswabas.disconnect

List sender pools

GET/v1/accounts/{AC}/sender-pools

senderPools.listSDK operation getV1AccountsByAcSenderPools

Required scope: senders:read.Paginated

Parameters

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

GET /v1/accounts/{AC}/sender-pools

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

Responses

Create a sender pool

POST/v1/accounts/{AC}/sender-pools

senderPools.createSDK operation postV1AccountsByAcSenderPools

Required scope: senders:write.Idempotency-Key required

Request body

namestring (max 128 chars)Required
senderSidsstring (WA… SID)[]Required
strategyenumRequired
round_robinleast_loadedsticky_contact

POST /v1/accounts/{AC}/sender-pools

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

Responses

Fetch a sender pool

GET/v1/accounts/{AC}/sender-pools/{SP}

senderPools.retrieveSDK operation getV1AccountsByAcSenderPoolsBySp

Required scope: senders:read.

Parameters

SPstring (SP… SID)Required

GET /v1/accounts/{AC}/sender-pools/{SP}

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

Responses

Update a sender pool

PATCH/v1/accounts/{AC}/sender-pools/{SP}

senderPools.updateSDK operation patchV1AccountsByAcSenderPoolsBySp

Required scope: senders:write.Idempotency-Key required

Parameters

SPstring (SP… SID)Required

Request body

namestring (max 128 chars)
senderSidsstring (WA… SID)[]
strategyenum
round_robinleast_loadedsticky_contact

PATCH /v1/accounts/{AC}/sender-pools/{SP}

curl -X PATCH "https://api.staging.toutye.com/v1/accounts/$TOUTYE_ACCOUNT_SID/sender-pools/SP..." \
  -H "Authorization: Bearer $TOUTYE_API_KEY" \
  -H "Toutye-Version: 2026-08-21" \
  -H "Idempotency-Key: $(uuidgen)"

Responses

Delete a sender pool

DELETE/v1/accounts/{AC}/sender-pools/{SP}

senderPools.deleteSDK operation deleteV1AccountsByAcSenderPoolsBySp

Required scope: senders:write.

Parameters

SPstring (SP… SID)Required

DELETE /v1/accounts/{AC}/sender-pools/{SP}

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

Responses

List WhatsApp senders and current provider readiness

GET/v1/accounts/{AC}/senders

senders.listSDK operation getV1AccountsByAcSenders

Required scope: senders:read.Paginated

Parameters

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

GET /v1/accounts/{AC}/senders

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

Responses

Subscribe a WABA and register a Cloud API sender

POST/v1/accounts/{AC}/senders

senders.createSDK operation postV1AccountsByAcSenders

Required scope: senders:write.Idempotency-Key required

Request body

displayNamestring (max 256 chars)Required
registrationobjectRequired
wabaSidstring (WB… SID)Required
phoneNumberstring (max 32 chars)
providerPhoneNumberIdstring (max 128 chars)

POST /v1/accounts/{AC}/senders

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

Responses

List provider storage regions permitted by this account's residency policy

GET/v1/accounts/{AC}/senders/storage-regions

senders.storageRegions.listSDK operation getV1AccountsByAcSendersStorageRegions

Required scope: senders:read.

GET /v1/accounts/{AC}/senders/storage-regions

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

Responses

Fetch a WhatsApp sender

GET/v1/accounts/{AC}/senders/{WA}

senders.retrieveSDK operation getV1AccountsByAcSendersByWa

Required scope: senders:read.

Parameters

WAstring (WA… SID)Required

GET /v1/accounts/{AC}/senders/{WA}

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

Responses

Update sender management settings

PATCH/v1/accounts/{AC}/senders/{WA}

senders.updateSDK operation patchV1AccountsByAcSendersByWa

A display-name change creates a durable Operation. statusCallbackUrl is a local verified-endpoint binding. Calling settings fail closed until Meta publishes an exact supported versioned write contract.

Required scope: senders:write.Idempotency-Key required

Parameters

WAstring (WA… SID)Required

Request body

callingSettingsobject
displayNamestring (max 256 chars)
nameEvidencestring (max 2000 chars)
statusCallbackUrlstring (uri, max 2048 chars) | null

PATCH /v1/accounts/{AC}/senders/{WA}

curl -X PATCH "https://api.staging.toutye.com/v1/accounts/$TOUTYE_ACCOUNT_SID/senders/WA..." \
  -H "Authorization: Bearer $TOUTYE_API_KEY" \
  -H "Toutye-Version: 2026-08-21" \
  -H "Idempotency-Key: $(uuidgen)"

Responses

Remove a sender locally without changing Meta assets

DELETE/v1/accounts/{AC}/senders/{WA}

senders.deleteSDK operation deleteV1AccountsByAcSendersByWa

Required scope: senders:write.

Parameters

WAstring (WA… SID)Required

DELETE /v1/accounts/{AC}/senders/{WA}

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

Responses

Block WhatsApp users

POST/v1/accounts/{AC}/senders/{WA}/block-users

senders.blockUsersSDK operation postV1AccountsByAcSendersByWaBlockUsers

Required scope: senders:write.Idempotency-Key required

Parameters

WAstring (WA… SID)Required

Request body

usersstring (max 64 chars)[]Required

POST /v1/accounts/{AC}/senders/{WA}/block-users

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

Responses

Unblock WhatsApp users

DELETE/v1/accounts/{AC}/senders/{WA}/block-users

senders.blockUsers.deleteSDK operation deleteV1AccountsByAcSendersByWaBlockUsers

Required scope: senders:write.

Parameters

WAstring (WA… SID)Required

Request body

usersstring (max 64 chars)[]Required

DELETE /v1/accounts/{AC}/senders/{WA}/block-users

curl -X DELETE "https://api.staging.toutye.com/v1/accounts/$TOUTYE_ACCOUNT_SID/senders/WA.../block-users" \
  -H "Authorization: Bearer $TOUTYE_API_KEY" \
  -H "Toutye-Version: 2026-08-21" \
  -H "Content-Type: application/json" \
  -d '{
  "users": []
}'

Responses

Get the current reconciled WhatsApp business profile

GET/v1/accounts/{AC}/senders/{WA}/business-profile

senders.businessProfile.listSDK operation getV1AccountsByAcSendersByWaBusinessProfile

Required scope: business_profiles:read.

Parameters

WAstring (WA… SID)Required

GET /v1/accounts/{AC}/senders/{WA}/business-profile

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

Responses

Create an Operation-backed WhatsApp business profile update

PATCH/v1/accounts/{AC}/senders/{WA}/business-profile

senders.businessProfile.updateSDK operation patchV1AccountsByAcSendersByWaBusinessProfile

Required scope: business_profiles:write.Idempotency-Key required

Parameters

WAstring (WA… SID)Required

Request body

reasonstring (max 2000 chars)Required
aboutstring (max 139 chars) | null
addressstring (max 256 chars) | null
categorystring (max 128 chars) | null
descriptionstring (max 512 chars) | null
emailstring (email, max 320 chars) | null
profileImageMediaSidstring (ME… SID) | null
websitesstring (uri, max 2048 chars)[]

PATCH /v1/accounts/{AC}/senders/{WA}/business-profile

curl -X PATCH "https://api.staging.toutye.com/v1/accounts/$TOUTYE_ACCOUNT_SID/senders/WA.../business-profile" \
  -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

Deregister a Cloud API sender

POST/v1/accounts/{AC}/senders/{WA}/deregister

senders.deregisterSDK operation postV1AccountsByAcSendersByWaDeregister

Creates a monitored DEREGISTER Operation. Coexistence numbers cannot be deregistered.: the provider decides the final state, so the answer is 200 with outcome: unknown and resolutionBy naming the Operation to watch.

Required scope: senders:write.Idempotency-Key required

Parameters

WAstring (WA… SID)Required

Request body

stepUpTokenstring (max 256 chars)Required

POST /v1/accounts/{AC}/senders/{WA}/deregister

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

Responses

Generate, upload and verify a sender Flow encryption key

POST/v1/accounts/{AC}/senders/{WA}/flows/keys

senders.flows.keysSDK operation postV1AccountsByAcSendersByWaFlowsKeys

Required scope: senders:write.Idempotency-Key required

Parameters

WAstring (WA… SID)Required

Request body

publicKeystring (max 8192 chars)Required

POST /v1/accounts/{AC}/senders/{WA}/flows/keys

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

Responses

Read Managed business-name requests

GET/v1/accounts/{AC}/senders/{WA}/name-requests

senders.nameRequests.listSDK operation getV1AccountsByAcSendersByWaNameRequests

Required scope: senders:read.

Parameters

WAstring (WA… SID)Required

GET /v1/accounts/{AC}/senders/{WA}/name-requests

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

Responses

200OK

Fetch sender opt-out keyword configuration

GET/v1/accounts/{AC}/senders/{WA}/opt-out-config

senders.optOutConfig.listSDK operation getV1AccountsByAcSendersByWaOptOutConfig

Required scope: senders:read.

Parameters

WAstring (WA… SID)Required

GET /v1/accounts/{AC}/senders/{WA}/opt-out-config

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

Responses

Replace sender opt-out keyword configuration

PUT/v1/accounts/{AC}/senders/{WA}/opt-out-config

senders.optOutConfig.updateSDK operation putV1AccountsByAcSendersByWaOptOutConfig

Required scope: senders:write.Idempotency-Key required

Parameters

WAstring (WA… SID)Required

Request body

confirmationobjectRequired
enabledbooleanRequired
languagesstring (max 35 chars)[]Required
matchModeenumRequired
tolerantexactstarts_withcontains
optInKeywordsstring (max 64 chars)[]Required
optOutKeywordsstring (max 64 chars)[]Required
scopeOnOptOutenumRequired
marketingall
confirmationTextsobject
excludedKeywordsstring (max 64 chars)[]

PUT /v1/accounts/{AC}/senders/{WA}/opt-out-config

curl -X PUT "https://api.staging.toutye.com/v1/accounts/$TOUTYE_ACCOUNT_SID/senders/WA.../opt-out-config" \
  -H "Authorization: Bearer $TOUTYE_API_KEY" \
  -H "Toutye-Version: 2026-08-21" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
  "confirmation": {},
  "enabled": true,
  "languages": [],
  "matchMode": "tolerant",
  "optInKeywords": [],
  "optOutKeywords": [],
  "scopeOnOptOut": "marketing"
}'

Responses

Read retained sender quality transitions

GET/v1/accounts/{AC}/senders/{WA}/quality-history

senders.qualityHistory.listSDK operation getV1AccountsByAcSendersByWaQualityHistory

Required scope: senders:read.Additionally, every one of these scopes is required: senders:read.Paginated

Parameters

WAstring (WA… SID)Required
fromstring (date-time)query
tostring (date-time)query
limitinteger (1–100)query
cursorstring (max 2048 chars)query
For subsequent pages retain the response from/to range; the cursor is bound to the exact sender, range and request scope.

GET /v1/accounts/{AC}/senders/{WA}/quality-history

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

Responses

Rotate the sender two-step verification PIN

POST/v1/accounts/{AC}/senders/{WA}/two-step-pin

senders.twoStepPinSDK operation postV1AccountsByAcSendersByWaTwoStepPin

Creates a monitored REGISTER Operation running the SET_TWO_STEP command. The PIN is sealed through the credential broker and is never returned or logged.

Required scope: senders:write.Idempotency-Key required

Parameters

WAstring (WA… SID)Required

Request body

stepUpTokenstring (max 256 chars)Required
pinstring (pattern ^[0-9]{6}$)

POST /v1/accounts/{AC}/senders/{WA}/two-step-pin

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

Responses

Request or submit a sender verification code

POST/v1/accounts/{AC}/senders/{WA}/verify

senders.verifySDK operation postV1AccountsByAcSendersByWaVerify

Creates a REGISTER Operation; verification codes are stored only as short-lived encrypted envelopes.

Required scope: senders:write.Idempotency-Key required

Parameters

WAstring (WA… SID)Required

Request body

codestring (pattern ^[0-9]{1,16}$)
codeMethodenum
smsvoice
localestring (pattern ^[a-z]{2,3}_[A-Z]{2}$)

POST /v1/accounts/{AC}/senders/{WA}/verify

curl -X POST "https://api.staging.toutye.com/v1/accounts/$TOUTYE_ACCOUNT_SID/senders/WA.../verify" \
  -H "Authorization: Bearer $TOUTYE_API_KEY" \
  -H "Toutye-Version: 2026-08-21" \
  -H "Idempotency-Key: $(uuidgen)"

Responses

Read the phone-level webhook override of a sender

GET/v1/accounts/{AC}/senders/{WA}/webhook-override

senders.webhookOverride.listSDK operation getV1AccountsByAcSendersByWaWebhookOverride

Required scope: senders:read.

Parameters

WAstring (WA… SID)Required

GET /v1/accounts/{AC}/senders/{WA}/webhook-override

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

Responses

Set or clear the phone-level webhook override of a sender

PATCH/v1/accounts/{AC}/senders/{WA}/webhook-override

senders.webhookOverride.updateSDK operation patchV1AccountsByAcSendersByWaWebhookOverride

Records the desired phone-level webhook_configuration and queues the SENDER_WEBHOOK_OVERRIDE management job that writes it to Meta. Phone-level takes precedence over the WABA-level override and the app default; the daily subscription reconcile keeps it converged.

Required scope: senders:write.Idempotency-Key required

Parameters

WAstring (WA… SID)Required

Request body

overrideCallbackUristring (pattern ^https://, max 2048 chars) | nullRequired
reasonstring (max 2000 chars)

PATCH /v1/accounts/{AC}/senders/{WA}/webhook-override

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

Responses

Disconnect a WABA and fence all of its senders

POST/v1/accounts/{AC}/wabas/{WB}/disconnect

wabas.disconnectSDK operation postV1AccountsByAcWabasByWbDisconnect

Required scope: wabas:write.Idempotency-Key required

Parameters

WBstring (WB… SID)Required

Request body

confirmDisplayNamestring (max 256 chars)Required
stepUpEvidencestring (max 4096 chars)Required

POST /v1/accounts/{AC}/wabas/{WB}/disconnect

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

Responses