Get marketing messages onboarding link

Returns a hosted onboarding link that walks a brand user through the lightweight marketing-messages signup flow for the given app.

Request parameters

Path parameters

KeyDescriptionValuesData TypeRequired/Optional
appIdIdentifier of the WhatsApp app the call acts on.6f414190-d45c-4671-bca1-fb6c3018cb13StringRequired

Query parameters

KeyDescriptionValuesData TypeRequired/Optional
langLanguage code for the generated content.enStringOptional

Sample cURL — Get marketing messages onboarding link.

curl --request GET \
  --url 'https://partner.gupshup.io/partner/bizgate/app/6f414190-d45c-4671-bca1-fb6c3018cb13/embed-onboarding/mmlite/onboarding-link?lang=en' \
  --header 'Authorization: Bearer <UT>' \
  --header 'Accept: application/json'

Sample success response (200)

{
  "status": "success",
  "data": {
    "link": "https://business.facebook.com/wa/manage/mmlite/onboarding?token=8f2c..."
  }
}
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
Query Params
Responses

Language
Credentials
Bearer
Universal Token (UT)
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json