API reference
Managed onboarding API reference descriptions are provided in English to preserve the exact published contract.
The state of this account's managed onboarding applications Apply for a WhatsApp number hosted in ShipMsg's own Meta portfolio Read the current managed setup and number procurement quote Answer a hosted setup request for more information Withdraw a hosted application before approval Accept a current managed service quote before future approved work Confirm the receiving phone for hosted service handover The state of this account's managed onboarding applications GET /v1/accounts/{AC}/managed-onboarding
getV1AccountsByAcManagedOnboarding200
Returns what the customer submitted and where it has got to. The sealed business details are returned only to a principal on the account itself, and 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
Parameters Name Type Required Description applicationSidquery · string (MA… SID) wabaSidquery · string (WB… SID) ACpath · string (AC… SID) yes Account SID
Errors: 400, 401, 403, 404, 409, 422, 429, 500, 503 — see errors .
Apply for a WhatsApp number hosted in ShipMsg's own Meta portfolio POST /v1/accounts/{AC}/managed-onboarding
postV1AccountsByAcManagedOnboardingIdempotency-Key required 201
For businesses that cannot complete Meta's own verification. The customer supplies their business details and instructs us to act for them; we create the WhatsApp Business Account inside our portfolio and port or buy the number. One open application per account: submitting twice while waiting would produce two accounts for one business in the portfolio whose accumulation Meta sanctions.
Required scope: `accounts:write`.
Parameters
Parameters Name Type Required Description ACpath · string (AC… SID) yes Account SID
Request body (15 fields) Request body Name Type Required Description acceptQuoteboolean yes acceptedQuoteFingerprintstring (pattern ^[0-9a-f]{64}$) yes acceptedTermsVersionstring (max 128 chars) yes countrystring (pattern ^[A-Z]{2}$) yes displayNamestring (max 200 chars) yes instructionstring (max 2000 chars) yes legalNamestring (max 200 chars) yes numberSource"PORT" | "PURCHASE" yes 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)
Errors: 400, 401, 403, 404, 409, 422, 429, 500, 503 — see errors .
Read the current managed setup and number procurement quote GET /v1/accounts/{AC}/managed-onboarding/quote
getV1AccountsByAcManagedOnboardingQuote200
Required scope: `accounts:read`.
Parameters
Parameters Name Type Required Description numberSourcequery · "PORT" | "PURCHASE" yes applicationSidquery · string (MA… SID) ACpath · string (AC… SID) yes Account SID
Errors: 400, 401, 403, 404, 409, 422, 429, 500, 503 — see errors .
Answer a hosted setup request for more information PATCH /v1/accounts/{AC}/managed-onboarding/{MA}
patchV1AccountsByAcManagedOnboardingByMaIdempotency-Key required 200
Required scope: `accounts:write`.
Parameters
Parameters Name Type Required Description ACpath · string (AC… SID) yes Account SID MApath · string (MA… SID) yes
Request body (1 fields) Request body Name Type Required Description informationstring (max 4000 chars) yes
Errors: 400, 401, 403, 404, 409, 422, 429, 500, 503 — see errors .
Withdraw a hosted application before approval DELETE /v1/accounts/{AC}/managed-onboarding/{MA}
deleteV1AccountsByAcManagedOnboardingByMa204
Required scope: `accounts:write`.
Parameters
Parameters Name Type Required Description ACpath · string (AC… SID) yes Account SID MApath · string (MA… SID) yes
Errors: 400, 401, 403, 404, 409, 422, 429, 500, 503 — see errors .
Accept a current managed service quote before future approved work POST /v1/accounts/{AC}/managed-onboarding/{MA}/accept-quote
postV1AccountsByAcManagedOnboardingByMaAcceptQuoteIdempotency-Key required 200
Required scope: `accounts:write`.
Parameters
Parameters Name Type Required Description ACpath · string (AC… SID) yes Account SID MApath · string (MA… SID) yes
Request body (3 fields) Request body Name Type Required Description acceptQuoteboolean yes acceptedQuoteFingerprintstring (pattern ^[0-9a-f]{64}$) yes acceptedTermsVersionstring (max 128 chars) yes
Errors: 400, 401, 403, 404, 409, 422, 429, 500, 503 — see errors .
Confirm the receiving phone for hosted service handover PATCH /v1/accounts/{AC}/managed-onboarding/{MA}/handover-phone
patchV1AccountsByAcManagedOnboardingByMaHandoverPhoneIdempotency-Key required 200
Required scope: `accounts:write`.
Parameters
Parameters Name Type Required Description ACpath · string (AC… SID) yes Account SID MApath · string (MA… SID) yes
Request body (1 fields) Request body Name Type Required Description handoverPhoneNumberstring (pattern ^\+[1-9][0-9]{6,14}$) yes
Errors: 400, 401, 403, 404, 409, 422, 429, 500, 503 — see errors .