Update application from Partner Portal

Use this API to update the WABA onboarding outside of Gupshup UI.

Request Parameters

Key Description Constraints

PARTNER_TOKEN

JWT Token issues post Partner login

Should be a valid Partner JWT Token.

templateMessaging

Toggle template messaging feature, initial default value is false.
If not passed the value is not updated.

boolean

storageRegion

Supported regions

IN - India
DE - Germany
BR - Brazil,
CH - Switzerland,
GB - Great Britain,
BH - Bahrain,
ZA - South Africa,
AE - United Arab Emirates,
US - USA,
CA - California,
AU - Australia,
ID - Indonesia,
JP - Japan,
SG - Singapore,
KR - South Korea

Can only be changed before adding the WABA id.

disableOptinPrefUrl

Use this flag to toggle Optin Preference URL

Boolean

Sample Request

curl --location --request PUT '{{partner_portal_base_url}}/partner/app/:appId' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'token: {{PARTNER_TOKEN}}'
--data-urlencode 'templateMessaging=<true/false>' \
--data-urlencode 'storageRegion=<BR, DE, CH, GB, BH, ZA, AE, US, CA, AU, ID, IN, JP, SG, KR>' \
--data-urlencode 'disableOptinPrefUrl=<true/false>' \

Sample Response

{
    "app": {
        "id": "<app_id>",
        "customerId" : <customerId>,
        "customerType" : <SALES_LED,DEFAULT,PARTNER>
        "billingType" : <POSTPAID,PREPAID>
        "createdOn": <epoch_timestamp>,
        "phone" : <phone_number_with_country_code>,
        "callbackUrl": "<callback_url>", //if set
        "disableOptinPrefUrl": <true/false>,
        "federated": <true/false>,
        "live": <true/false>,
        "modifiedOn": <epoch_timestamp>,
        "name": "<APP_NAME>",
        "stopped": <true/false>,
        "templateMessaging": <true/false>,
        "type": "apicallbackpost",
        "storageRegion" : "US"
        "version": <0,1,2>
    },
    "status": "success"
}

Status Codes

Status CodeResponseComments
Success
200{ "app": { "id": "\<app_id>", "customerId" : <customerId>, "customerType" : \<SALES_LED,DEFAULT,PARTNER> "billingType" : \<POSTPAID,PREPAID> "createdOn": \<epoch_timestamp>, "phone" : \<phone_number_with_country_code>, "callbackUrl": "\<callback_url>", //if set "disableOptinPrefUrl": \<true/false>, "federated": \<true/false>, "live": \<true/false>, "modifiedOn": \<epoch_timestamp>, "name": "\<APP_NAME>", "stopped": \<true/false>, "templateMessaging": \<true/false>, "type": "apicallbackpost", "storageRegion" : "US" "version": \<0,1,2> }, "status": "success" }
Error
400{ "status": "error", "message": "Cannot Change Region After Go live" }trying to update region after go live
400{ "status": "error", "message": "Invalid Region Passed" }Invalid region code
400{ "status": "error", "message": "Fields to be updated not provided." }When no fields are passed
429{ "status": "error", "message": "Too Many Requests" }10 Requests per Second
500{ "status": "error", "message": "Unable to update details. Please try again or contact support." }For any Internal Error
Language
Click Try It! to start a request and see the response here!