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

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

List resumable and recent Embedded Signup sessions

GET/v1/accounts/{AC}/onboarding/sessions

onboarding.sessions.listSDK operation getV1AccountsByAcOnboardingSessions

Required scope: senders:read.Paginated

Parameters

  • limitinteger (1–100)query
  • cursorstring (max 2048 chars)query

Create an Embedded Signup v4 session

POST/v1/accounts/{AC}/onboarding/sessions

onboarding.sessions.createSDK operation postV1AccountsByAcOnboardingSessions

Required scope: senders:write.Idempotency-Key required

Request body

  • dashboardSessionIdstring (max 512 chars)Required
  • hostedboolean
  • reconnectOperationSidstring (OP… SID)

Fetch an Embedded Signup session

GET/v1/accounts/{AC}/onboarding/sessions/{id}

onboarding.sessions.retrieveSDK operation getV1AccountsByAcOnboardingSessionsById

Required scope: senders:read.

Parameters

  • idstring (uuid)Required

Cancel an unfinished Embedded Signup session

POST/v1/accounts/{AC}/onboarding/sessions/{id}/cancel

onboarding.sessions.cancelSDK operation postV1AccountsByAcOnboardingSessionsByIdCancel

Required scope: senders:write.Idempotency-Key required

Parameters

  • idstring (uuid)Required

Consume an Embedded Signup event and exchange its code

POST/v1/accounts/{AC}/onboarding/sessions/{id}/complete

onboarding.sessions.completeSDK operation postV1AccountsByAcOnboardingSessionsByIdComplete

Required scope: senders:write.Idempotency-Key required

Parameters

  • idstring (uuid)Required

Request body

  • dashboardSessionIdstring (max 512 chars)Required
  • eventenumRequired

    FINISHFINISH_ONLY_WABAFINISH_WHATSAPP_BUSINESS_APP_ONBOARDINGFINISH_OBO_MIGRATIONFINISH_GRANT_ONLY_API_ACCESSCANCELERROR

  • statestring (max 256 chars)Required
  • businessIdstring (max 128 chars)
  • codestring (max 4096 chars)
  • currentStepstring (max 128 chars)
  • errorMessagestring (max 1024 chars)
  • phoneNumberIdstring (max 128 chars)
  • portfolioIdstring (max 128 chars)
  • sessionIdstring (max 512 chars)
  • wabaIdstring (max 128 chars)

Explain the exact onboarding readiness decision and next action

GET/v1/accounts/{AC}/onboarding/sessions/{id}/readiness

onboarding.sessions.readiness.listSDK operation getV1AccountsByAcOnboardingSessionsByIdReadiness

Required scope: senders:read.

Parameters

  • idstring (uuid)Required

List authorized WhatsApp Business Accounts

GET/v1/accounts/{AC}/wabas

wabas.listSDK operation getV1AccountsByAcWabas

Required scope: wabas:read.

Parameters

  • businessIdstring (max 128 chars)query
  • limitinteger (1–100)query