Generate embed signed link

post

https://partner.gupshup.io/partner/bizgate/app/{appId}/onboarding/embed/link

Generates a signed URL that launches the embedded WhatsApp signup and verification flow for a specific app.

Request parameters

Path parameters

Key	Description	Values	Data Type	Required/Optional
appId	Identifier of the WhatsApp app the call acts on.	6f414190-d45c-4671-bca1-fb6c3018cb13	String	Required

Query parameters

Key	Description	Values	Data Type	Required/Optional
user	Portal user the signed link is generated for.	[email protected]	String	Required
regenerate	Whether to issue a fresh link instead of reusing the current one.	false	Boolean	Optional
lang	Language code for the generated content.	en	String	Optional

Sample cURL — Generate embed signed link.

curl --request POST \
  --url 'https://partner.gupshup.io/partner/bizgate/app/6f414190-d45c-4671-bca1-fb6c3018cb13/onboarding/embed/[email protected]&regenerate=false&lang=en' \
  --header 'Authorization: Bearer <UT>' \
  --header 'Accept: application/json'

Sample success response (200)

{
  "status": "success",
  "data": {
    "link": "https://www.gupshup.io/whatsapp/embed-signup?token=eyJhcHBJZCI6IjZmNDE0MTkwLWQ0NWMtNDY3MS1iY2ExLWZiNmMzMDE4Y2IxMyJ9&lang=en"
  }
}

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Responses

Language

Credentials

Bearer

Universal Token (UT)

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Success

401Unauthorized — missing, expired, or invalid bearer token

403Forbidden — authenticated but not permitted for this resource

404No application was found for this ID under your partner account, or the app does not yet have a WhatsApp API key. Verify the app ID belongs to your partner and that the app is provisioned.

429Rate limit exceeded for this endpoint

500Unexpected server error.