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

Onboarding cases

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

Your onboarding cases, with each step's owner and standing

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

onboardingCases.listSDK operation getV1AccountsByAcOnboardingCases

Required scope: accounts:read.

Ask Toutye to take you through Meta's setup (assisted onboarding)

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

onboardingCases.createSDK operation postV1AccountsByAcOnboardingCases

Opens an onboarding case. You keep your own WhatsApp Business Account and Meta bills you directly; we prepare and submit what a Tech Provider may, and track the rest. The one-time fee as it stands today is recorded on the case and charged when we take it on, from your live wallet. This setup engagement ends after full setup and delivered handover; it does not include ongoing Meta management. One open case per account scope.

Required scope: accounts:write.Idempotency-Key required

Request body

  • acceptFeebooleanRequired
  • acceptedFeeobjectRequired
    Show 6 child attributes
    • amountMinorstring (pattern ^[0-9]+$)Required
    • currencystring (pattern ^[A-Z]{3}$)Required
    • feeIdstring (uuid)Required
    • policyVersion"2026-10-24.prework-wallet.v1"Required
    • scaleinteger (0–9)Required
    • versioninteger (1–)Required
  • businessNamestring (max 200 chars)Required
  • contactEmailstring (max 320 chars)Required
  • contactNamestring (max 200 chars)Required
  • handoverPhoneNumberstring (pattern ^\+[1-9][0-9]{6,14}$)Required
  • instructionstring (max 2000 chars)Required
  • onboardingPhoneNumberstring (pattern ^\+[1-9][0-9]{6,14}$)Required

Read an assisted case and its retained fee, steps and handover evidence

GET/v1/accounts/{AC}/onboarding-cases/{OC}

onboardingCases.retrieveSDK operation getV1AccountsByAcOnboardingCasesByOc

Required scope: accounts:read.

Parameters

  • OCstring (OC… SID)Required

Confirm or correct the business and handover numbers on an open assisted case

PATCH/v1/accounts/{AC}/onboarding-cases/{OC}

onboardingCases.updateSDK operation patchV1AccountsByAcOnboardingCasesByOc

Required scope: accounts:write.Idempotency-Key required

Parameters

  • OCstring (OC… SID)Required

Request body

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

Cancel your pending assisted onboarding request without deleting its fee or history

POST/v1/accounts/{AC}/onboarding-cases/{OC}/cancel

onboardingCases.cancelSDK operation postV1AccountsByAcOnboardingCasesByOcCancel

Required scope: accounts:write.Idempotency-Key required

Parameters

  • OCstring (OC… SID)Required

Request body

  • reasonstring (max 1000 chars)Required

Customer confirms their own assisted setup action; provider standing is not asserted

POST/v1/accounts/{AC}/onboarding-cases/{OC}/steps/{stepKey}/confirm

onboardingCases.steps.confirmSDK operation postV1AccountsByAcOnboardingCasesByOcStepsByStepkeyConfirm

Required scope: accounts:write.Idempotency-Key required

Parameters

  • OCstring (OC… SID)Required
  • stepKeyenumRequired

    PORTFOLIOEMBEDDED_SIGNUPPAYMENT_METHOD

Request body

  • confirmationstring (max 2000 chars)Required