Managed onboarding

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

GETReview scoped assigned-number inactivity warningsmanagedInactivity.list
POSTAcknowledge genuine receipt of an exact current assignment warningmanagedInactivity.acknowledge
GETThe state of this account's managed onboarding applicationsmanagedOnboarding.list
POSTApply for a Toutye-managed WhatsApp numbermanagedOnboarding.create
GETRead the current Managed setup quotemanagedOnboarding.quote.list
PATCHAnswer a hosted setup request for more informationmanagedOnboarding.update
DELETEWithdraw a hosted application before approvalmanagedOnboarding.delete
POSTAccept a current managed service quote before future approved workmanagedOnboarding.acceptQuote
GETRead the exact one-time number activation offermanagedOnboarding.activation.list
POSTAccept and settle the assigned number's one-time feemanagedOnboarding.activation.accept
PATCHConfirm the receiving phone for hosted service handovermanagedOnboarding.handoverPhone.update
POSTConfirm the handover of the Toutye number assigned to youmanagedOnboarding.handover.confirm

Review scoped assigned-number inactivity warnings

GET/v1/accounts/{AC}/managed-inactivity

managedInactivity.listSDK operation getV1AccountsByAcManagedInactivity

Required scope: accounts:read.

Parameters

applicationSidstring (MA… SID)query
afterApplicationSidstring (MA… SID)query

GET /v1/accounts/{AC}/managed-inactivity

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

Responses

Acknowledge genuine receipt of an exact current assignment warning

POST/v1/accounts/{AC}/managed-inactivity/{warningId}/acknowledge

managedInactivity.acknowledgeSDK operation postV1AccountsByAcManagedInactivityByWarningidAcknowledge

Required scope: accounts:write.Idempotency-Key required

Parameters

warningIdstring (uuid)Required

Request body

acknowledgeReceipttrueRequired
fingerprintstring (pattern ^[a-f0-9]{64}$)Required

POST /v1/accounts/{AC}/managed-inactivity/{warningId}/acknowledge

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

Responses

The state of this account's managed onboarding applications

GET/v1/accounts/{AC}/managed-onboarding

managedOnboarding.listSDK operation getV1AccountsByAcManagedOnboarding

Returns what the customer submitted and where it has got to. The sealed business details (registration and tax numbers, address, representative) are returned only to a principal on the account itself who may also change the account (accounts:write); other readers see businessDetailsRestricted instead. The response says plainly when they could not be opened rather than presenting an empty form as though nothing was ever entered.

Required scope: accounts:read.

Parameters

applicationSidstring (MA… SID)query
wabaSidstring (WB… SID)query

GET /v1/accounts/{AC}/managed-onboarding

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

Responses

Apply for a Toutye-managed WhatsApp number

POST/v1/accounts/{AC}/managed-onboarding

managedOnboarding.createSDK operation postV1AccountsByAcManagedOnboarding

Managed: Toutye assigns one of its own WhatsApp numbers, already registered with an approved display name under Toutye's WhatsApp Business Account. Nothing is created at Meta for the customer. After staff review and approval a number is assigned from Toutye's inventory and the customer confirms the handover. Managed numbers run under stricter rules (staff-approved templates, mandatory opt-in evidence, lower starting limits, earlier pauses, refused high-risk categories). One open application per account and workspace.

Required scope: accounts:write.Idempotency-Key required

Request body

acceptQuotebooleanRequired
acceptedQuoteFingerprintstring (pattern ^[0-9a-f]{64}$)Required
acceptedTermsVersionstring (max 128 chars)Required
businessCategoryenumRequired
RETAIL_ECOMMERCEFOOD_RESTAURANTSTRAVEL_HOSPITALITYEDUCATIONHEALTH_CLINICSPROFESSIONAL_SERVICESLOGISTICS_DELIVERYBEAUTY_WELLNESSREAL_ESTATEAUTOMOTIVENONPROFITTELECOM_UTILITIESENTERTAINMENT_EVENTSFINANCIAL_SERVICESOTHERADULTGAMBLINGDATINGALCOHOLTOBACCO_VAPINGWEAPONSDRUGS_PHARMACYCRYPTOCURRENCYLENDING_DEBT_COLLECTIONMULTI_LEVEL_MARKETINGPOLITICAL
countrystring (pattern ^[A-Z]{2}$)Required
displayNamestring (max 200 chars)Required
instructionstring (max 2000 chars)Required
legalNamestring (max 200 chars)Required
numberSourceenum
TOUTYE_INVENTORYPORT
registeredAddressstring (max 500 chars)
registrationNumberstring (max 120 chars)
representativeEmailstring (max 320 chars)
representativeNamestring (max 200 chars)
requestedNumberstring (pattern ^\+[1-9][0-9]{6,14}$)
taxIdstring (max 120 chars)
websitestring (max 500 chars)

POST /v1/accounts/{AC}/managed-onboarding

curl -X POST "https://api.staging.toutye.com/v1/accounts/$TOUTYE_ACCOUNT_SID/managed-onboarding" \
  -H "Authorization: Bearer $TOUTYE_API_KEY" \
  -H "Toutye-Version: 2026-08-21" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
  "acceptQuote": true,
  "acceptedQuoteFingerprint": "string",
  "acceptedTermsVersion": "string",
  "businessCategory": "RETAIL_ECOMMERCE",
  "country": "string",
  "displayName": "string",
  "instruction": "string",
  "legalName": "string"
}'

Responses

Read the current Managed setup quote

GET/v1/accounts/{AC}/managed-onboarding/quote

managedOnboarding.quote.listSDK operation getV1AccountsByAcManagedOnboardingQuote

Required scope: accounts:read.

Parameters

numberSourceenumqueryRequired
TOUTYE_INVENTORYPORT
applicationSidstring (MA… SID)query

GET /v1/accounts/{AC}/managed-onboarding/quote

curl "https://api.staging.toutye.com/v1/accounts/$TOUTYE_ACCOUNT_SID/managed-onboarding/quote?numberSource=TOUTYE_INVENTORY" \
  -H "Authorization: Bearer $TOUTYE_API_KEY" \
  -H "Toutye-Version: 2026-08-21"

Responses

Answer a hosted setup request for more information

PATCH/v1/accounts/{AC}/managed-onboarding/{MA}

managedOnboarding.updateSDK operation patchV1AccountsByAcManagedOnboardingByMa

Required scope: accounts:write.Idempotency-Key required

Parameters

MAstring (MA… SID)Required

Request body

informationstring (max 4000 chars)Required

PATCH /v1/accounts/{AC}/managed-onboarding/{MA}

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

Responses

Withdraw a hosted application before approval

DELETE/v1/accounts/{AC}/managed-onboarding/{MA}

managedOnboarding.deleteSDK operation deleteV1AccountsByAcManagedOnboardingByMa

Required scope: accounts:write.

Parameters

MAstring (MA… SID)Required

DELETE /v1/accounts/{AC}/managed-onboarding/{MA}

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

Responses

Accept a current managed service quote before future approved work

POST/v1/accounts/{AC}/managed-onboarding/{MA}/accept-quote

managedOnboarding.acceptQuoteSDK operation postV1AccountsByAcManagedOnboardingByMaAcceptQuote

Required scope: accounts:write.Idempotency-Key required

Parameters

MAstring (MA… SID)Required

Request body

acceptQuotebooleanRequired
acceptedQuoteFingerprintstring (pattern ^[0-9a-f]{64}$)Required
acceptedTermsVersionstring (max 128 chars)Required

POST /v1/accounts/{AC}/managed-onboarding/{MA}/accept-quote

curl -X POST "https://api.staging.toutye.com/v1/accounts/$TOUTYE_ACCOUNT_SID/managed-onboarding/MA.../accept-quote" \
  -H "Authorization: Bearer $TOUTYE_API_KEY" \
  -H "Toutye-Version: 2026-08-21" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
  "acceptQuote": true,
  "acceptedQuoteFingerprint": "string",
  "acceptedTermsVersion": "string"
}'

Responses

Read the exact one-time number activation offer

GET/v1/accounts/{AC}/managed-onboarding/{MA}/activation

managedOnboarding.activation.listSDK operation getV1AccountsByAcManagedOnboardingByMaActivation

Required scope: accounts:read.

Parameters

MAstring (MA… SID)Required

GET /v1/accounts/{AC}/managed-onboarding/{MA}/activation

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

Responses

Accept and settle the assigned number's one-time fee

POST/v1/accounts/{AC}/managed-onboarding/{MA}/activation/accept

managedOnboarding.activation.acceptSDK operation postV1AccountsByAcManagedOnboardingByMaActivationAccept

Required scope: accounts:write.Idempotency-Key required

Parameters

MAstring (MA… SID)Required

Request body

acceptQuotebooleanRequired
acceptedQuoteFingerprintstring (pattern ^[0-9a-f]{64}$)Required
acceptedTermsVersionstring (max 128 chars)Required

POST /v1/accounts/{AC}/managed-onboarding/{MA}/activation/accept

curl -X POST "https://api.staging.toutye.com/v1/accounts/$TOUTYE_ACCOUNT_SID/managed-onboarding/MA.../activation/accept" \
  -H "Authorization: Bearer $TOUTYE_API_KEY" \
  -H "Toutye-Version: 2026-08-21" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
  "acceptQuote": true,
  "acceptedQuoteFingerprint": "string",
  "acceptedTermsVersion": "string"
}'

Responses

Confirm the receiving phone for hosted service handover

PATCH/v1/accounts/{AC}/managed-onboarding/{MA}/handover-phone

managedOnboarding.handoverPhone.updateSDK operation patchV1AccountsByAcManagedOnboardingByMaHandoverPhone

Required scope: accounts:write.Idempotency-Key required

Parameters

MAstring (MA… SID)Required

Request body

handoverPhoneNumberstring (pattern ^\+[1-9][0-9]{6,14}$)Required

PATCH /v1/accounts/{AC}/managed-onboarding/{MA}/handover-phone

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

Responses

Confirm the handover of the Toutye number assigned to you

POST/v1/accounts/{AC}/managed-onboarding/{MA}/handover/confirm

managedOnboarding.handover.confirmSDK operation postV1AccountsByAcManagedOnboardingByMaHandoverConfirm

Required scope: accounts:write.Idempotency-Key required

Parameters

MAstring (MA… SID)Required

Request body

confirmtrueRequired

POST /v1/accounts/{AC}/managed-onboarding/{MA}/handover/confirm

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

Responses