post https://partner.gupshup.io/partner/app
Use this API to create a new 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. |
name |
Name for the app |
|
templateMessaging |
Toggle template messaging feature, the initial default value is false. |
Boolean |
disableOptinPrefUrl |
Use this flag to toggle optin preferences - Mark User Optin or Optout |
Boolean |
Sample Request
curl --location --request POST '{{partner_portal_base_url}}/partner/app' \
--header 'token: {{PARTNER_TOKEN}}' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'name={{appName}}' \
--data-urlencode 'templateMessaging=<true/false>' \
--data-urlencode 'disableOptinPrefUrl=<true/false>'
Sample Response
{
"appId": "<app_id>"
}
Status Codes
Status Code | Response | Comments |
---|---|---|
Success | ||
200 | { "appId": "<app_id>" } | |
Error | ||
400 | { "status": "error", "message": "Invalid characters used in app name" } | When a Special character is added in the name. |
400 | { "status": "error", "message": "App name should be between 6 to 150 characters in length" } | if App name is not provided or App name length is less than 6 or more than 150 characters. |
409 | { "status": "error", "message": "Bot Already Exists" } | When already a bot with same name exists in gupshup |
429 | { "status": "error", "message": "Too Many Requests" } | 10 Requests per Minute |
500 | { "status": "error", "message": "Unable to create App" } | For any Internal Error |