post
https://partner.gupshup.io/partner/bizgate/partner//app
Creates a new WhatsApp app under the given partner account with the supplied name, wallet, and optional phone number.
Request parameters
Path parameters
| Key | Description | Values | Data Type | Required/Optional |
|---|---|---|---|---|
| partnerId | Identifier of the partner account. Must be the partner the token authenticates. | 13824 | Integer | Required |
Body
| Key | Description | Values | Data Type | Required/Optional |
|---|---|---|---|---|
| name | Name for the new app. Must be unique across the partner's apps. | acme-support | — | Required |
| phone | Phone number to onboard, in international format without the plus sign. | 91XXXXXXXX10 | — | Optional |
| customerId | Customer the app belongs to. Taken from the wallet when walletId is supplied. | 90000123 | — | Optional |
| walletId | Wallet the app's usage is billed to. Must be one of this partner's wallets. | 1234567 | — | Optional |
| metadata | JSON object of app metadata. Include service=whatsapp to provision a WhatsApp app. | {"service":"whatsapp"} | — | Optional |
| bypassSolutionId | Set true to create the app without attaching the partner's approved solution id. | false | — | Optional |
Sample cURL — Create a new app for a partner.
curl --request POST \
--url 'https://partner.gupshup.io/partner/bizgate/partner/13824/app' \
--header 'Authorization: Bearer <UT>' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"name" : "acme-support",
"phone" : "91XXXXXXXX10",
"customerId" : 90000123,
"walletId" : 1234567,
"metadata" : {
"service" : "whatsapp"
},
"bypassSolutionId" : false
}'Sample success response (200)
{
"status": "success",
"data": {
"id": "39ebad1e-7eab-4f07-aaee-d454e0cf00ac",
"name": "AcmeSupport",
"phone": "91XXXXXXXX10",
"customerId": "1000123456",
"walletId": "50000838",
"live": false,
"partnerId": 13824,
"createdOn": 1720203204000,
"modifiedOn": 1720203204000,
"partnerCreated": true,
"cxpEnabled": false,
"partnerUsage": false,
"stopped": false,
"healthy": false,
"cap": 0.0
}
}Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…