Skip to main content

Changes to Gupshup Go-Live APIs and Onboarding Flow effective Nov 24 2025

Gupshup
Updated
WHATS CHANGING ?
We’re introducing some important improvements to the Go-Live onboarding flow to simplify state management, improve error handling, and provide better retry mechanisms. These changes will start showing on the interface/s and APIs starting 24th November 2025. Previously, our interface and backend did not handle a lot of onboarding failures. Now, users of interface or API adopters will be able to experience better onboarding with multiple scenarios handled to guide user accordingly. Detailed error messages, retry, and “Report to Gupshup” actions are available directly in the UI.
 
IMPACT?
For those who use the Gupshup interface/s or their customers use it, there is no impact. The new flow will make the go-live process easier and more error-proof, with exact guidance on what to do incase onboarding fails. 
Also, partners onboarding through the partner portal now get benefit of smoother onboarding if they indicate on the UI that it is a 'migration' phone number to be onboarded [already live on another BSP]. 
 
For those who use the partner onboarding APIs and if your integration currently uses certain fields and values in the GET /partner/app/list API [to make custom logic based on onboarding stage and to track/show app or onboarding statuses in your UI], your integrations may break with this change after 24th Nov. Thus please review the following updates and prepare your systems in advance. [same for Tech Provider SDK get status API users]

  1. Existing Field : ui_form_stage –
    New standardized values for each onboarding step. However we DO NOT recommend you to consume this field.

2. Existing Field : pipeline_stage –
Now includes distinct stages:
NONE, WABA_SETUP, CREATE_CLOUD_SETUP, BILLING_SETUP, and FINALIZE

3. New field : pipeline_status –
New field indicating progress - IN_PROGRESS, SUCCESS, ERROR

4. New field : pipeline_error –
New field showing user-facing or custom error messages

5. Existing fields that will be redundant/not to be used - creationStage, whatsappVerificationStatus, and embedStage will no longer update with onboarding progress (the values for these will remain INITIAL or NONE).

6. New APIs: Onboarding API users can now make use of 2 new APIs to enhance their own onboarding flows. 

a. Get Onboarding Pipeline Status

→ Use this to fetch real-time onboarding status, error messages, and resolution hints.

Documentation to be provided soon.

b. Retry Onboarding Pipeline

→ Use this to resume onboarding from the failed stage.

  • Documentation to be provided soon.

 

Action Required for Partners

Please update your systems to:

  • Read and display statuses from the new fields/values (pipeline_stage, pipeline_status, pipeline_error).

  • Handle retry and error flows using the new APIs, if needed

  • Stop relying on deprecated fields (creationStage, embedStage, etc.).

  • DO NOT consume 'ui_form_stage' field 

 

If you use the Tech Provider Embed SDK for onboarding, kindly get in touch with your CSM for further guidance.

Related articles

Comments

0 comments

Please sign in to leave a comment.