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 hosted WhatsApp exit progress Request a free hosted-number exit and complete customer-data export Request a hosted-exit prepaid balance refund or transfer Retry a failed or expired hosted-exit export Confirm receipt of the hosted exit export Read hosted portfolio containment and termination notices GET /v1/accounts/{AC}/managed-service/containment
getV1AccountsByAcManagedServiceContainment200
Required scope: `accounts:read`.
Parameters
Parameters Name Type Required Description ACpath · string (AC… SID) yes
Errors: 400, 401, 403, 404, 409, 422, 429, 500, 503 — see errors .
Get hosted WhatsApp exit progress GET /v1/accounts/{AC}/managed-service/wabas/{WB}/exit
getV1AccountsByAcManagedServiceWabasByWbExit200
Required scope: `accounts:read`.
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
Parameters Name Type Required Description ACpath · string (AC… SID) yes WBpath · string (WB… SID) yes
Errors: 400, 401, 403, 404, 409, 422, 429, 500, 503 — see errors .
Request a free hosted-number exit and complete customer-data export POST /v1/accounts/{AC}/managed-service/wabas/{WB}/exit
postV1AccountsByAcManagedServiceWabasByWbExitIdempotency-Key required 202
Required scope: `accounts:write`.
Additionally, every one of these scopes is required: `accounts:write`, `exports:create`, `media:read`, `messages:read`, `contacts:read`, `contacts:read_identifiers`, `templates:read`, `conversations:read`.
When balanceRequest is REFUND or TRANSFER, billing:write is also required. NONE or an omitted balanceRequest does not require that financial instruction scope.
Parameters
Parameters Name Type Required Description ACpath · string (AC… SID) yes WBpath · string (WB… SID) yes
Request body (2 fields) Request body Name Type Required Description balanceRequest"NONE" | "REFUND" | "TRANSFER" stepUpTokenstring yes
Errors: 400, 401, 403, 404, 409, 422, 429, 500, 503 — see errors .
Request a hosted-exit prepaid balance refund or transfer POST /v1/accounts/{AC}/managed-service/wabas/{WB}/exit/balance-request
postV1AccountsByAcManagedServiceWabasByWbExitBalanceRequestIdempotency-Key required 202
Required scope: `accounts:write`.
Additionally, every one of these scopes is required: `accounts:write`, `billing:write`.
Parameters
Parameters Name Type Required Description ACpath · string (AC… SID) yes WBpath · string (WB… SID) yes
Request body (4 fields) Request body Name Type Required Description amountMinorstring (pattern ^[1-9][0-9]{0,17}$) destinationWalletIdstring (uuid) kind"REFUND" | "TRANSFER" yes sourceWalletIdstring (uuid)
Errors: 400, 401, 403, 404, 409, 422, 429, 500, 503 — see errors .
Retry a failed or expired hosted-exit export POST /v1/accounts/{AC}/managed-service/wabas/{WB}/exit/export
postV1AccountsByAcManagedServiceWabasByWbExitExportIdempotency-Key required 202
Required scope: `accounts:write`.
Additionally, every one of these scopes is required: `accounts:write`, `exports:create`, `media:read`, `messages:read`, `contacts:read`, `contacts:read_identifiers`, `templates:read`, `conversations:read`.
Parameters
Parameters Name Type Required Description ACpath · string (AC… SID) yes WBpath · string (WB… SID) yes
Request body (1 fields) Request body Name Type Required Description stepUpTokenstring yes
Errors: 400, 401, 403, 404, 409, 422, 429, 500, 503 — see errors .
Confirm receipt of the hosted exit export POST /v1/accounts/{AC}/managed-service/wabas/{WB}/exit/export-received
postV1AccountsByAcManagedServiceWabasByWbExitExportReceivedIdempotency-Key required 200
Required scope: `accounts:write`.
Additionally, every one of these scopes is required: `accounts:write`, `exports:create`.
Parameters
Parameters Name Type Required Description ACpath · string (AC… SID) yes WBpath · string (WB… SID) yes
Request body (1 fields) Request body Name Type Required Description receivedtrue yes
Errors: 400, 401, 403, 404, 409, 422, 429, 500, 503 — see errors .