Create a hosted onboarding session for a customer

Call this from your backend when a customer wants to connect WhatsApp. Send an allowed HTTPS returnUrl and optional opaque metadata that identifies the customer in your system. Set connectionMode to coexistence to keep an existing WhatsApp Business App number active while adding Cloud API access. Coexistence requires the dedicated Meta configuration and cannot be used as a number-migration destination. Redirect the customer to hostedUrl. The session expires after 15 minutes and no managed user is created until the hosted Meta Embedded Signup succeeds.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
enum
Defaults to standard

WhatsApp onboarding mode. Omit this field to preserve the standard Embedded Signup flow.

Allowed:
metadata
object

Opaque provider context returned unchanged with the completed onboarding result and webhook.

uri
required

Allowed HTTPS URL where the hosted flow returns the customer.

Response

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json