Docs
Esc

Suggested

QuickstartGet started
Webhooks and signaturesMessaging
Create a messagemessages.create · POST /v1/accounts/{AC}/messages
RATE_LIMITED429 · Rate limit exceeded.
message.deliveredMessage resource
Contents

API reference

managed-service

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

Read hosted portfolio containment and termination notices

GET/v1/accounts/{AC}/managed-service/containment

managedService.containment.listSDK operation getV1AccountsByAcManagedServiceContainment

Get hosted WhatsApp exit progress

GET/v1/accounts/{AC}/managed-service/wabas/{WB}/exit

managedService.wabas.exit.listSDK operation getV1AccountsByAcManagedServiceWabasByWbExit

Financial balance details require billing:read. Otherwise balance contains only state=unavailable, available=false and reason=BILLING_READ_REQUIRED; no amounts, instructions or provider references are returned.

Parameters

  • WBstring (WB… SID)Required

Request a free hosted-number exit and complete customer-data export

POST/v1/accounts/{AC}/managed-service/wabas/{WB}/exit

managedService.wabas.exit.createSDK operation postV1AccountsByAcManagedServiceWabasByWbExit

When balanceRequest is REFUND or TRANSFER, billing:write is also required. NONE or an omitted balanceRequest does not require that financial instruction scope.

Parameters

  • WBstring (WB… SID)Required

Request body

  • stepUpTokenstringRequired
  • balanceRequestenum

    NONEREFUNDTRANSFER

Request a hosted-exit prepaid balance refund or transfer

POST/v1/accounts/{AC}/managed-service/wabas/{WB}/exit/balance-request

managedService.wabas.exit.balanceRequestSDK operation postV1AccountsByAcManagedServiceWabasByWbExitBalanceRequest

Parameters

  • WBstring (WB… SID)Required

Request body

  • kindenumRequired

    REFUNDTRANSFER

  • amountMinorstring (pattern ^[1-9][0-9]{0,17}$)
  • destinationWalletIdstring (uuid)
  • sourceWalletIdstring (uuid)

Retry a failed or expired hosted-exit export

POST/v1/accounts/{AC}/managed-service/wabas/{WB}/exit/export

managedService.wabas.exit.exportSDK operation postV1AccountsByAcManagedServiceWabasByWbExitExport

Parameters

  • WBstring (WB… SID)Required

Request body

  • stepUpTokenstringRequired

Confirm receipt of the hosted exit export

POST/v1/accounts/{AC}/managed-service/wabas/{WB}/exit/export-received

managedService.wabas.exit.exportReceivedSDK operation postV1AccountsByAcManagedServiceWabasByWbExitExportReceived

Parameters

  • WBstring (WB… SID)Required

Request body

  • receivedtrueRequired