Request Parameters
| Key | Description | Constraints |
|---|---|---|
| Headers | ||
| apikey | Apikey of the account where the app is to be created | Should be a valid gupshup.io apikey |
| Path Params | ||
| appId | Valid app id | |
| Form Params | ||
| addressLine1 | Address of the business | |
| addressLine2 | Address of the business | |
| city | City where business is situated | |
| state | State where business is situated | |
| country | Country where business is situated | |
| pincode | Pincode where business is situated | |
| desc | Description of the business | |
| vertical | Type/Category of business | |
| ProfileEmail | Email of business | |
| website1 | Website of business | |
| website2 | Website of business |
Response Parameters
| Key | Description |
|---|---|
| addressLine1 | Address of the business |
| addressLine2 | Address of the business |
| city | City where business is situated |
| state | State where business is situated |
| country | Country where business is situated |
| pincode | Pincode of the city where business is situated |
| desc | Description of the business |
| vertical | Type/Category of business |
| profileEmail | Email of business |
| website1 | Website of business |
| website2 | Website of business |
Status Codes
| Status Code | Response | Comments |
|---|---|---|
Success | ||
200 | { | |
Error | ||
400 | { | When invalid/empty appId is provided |
400 | { | When app is not live |
400 | { | When docker authentication fails |
400 | { | When Facebook returns error while setting business profile details |
400 | { | When vertical field is empty |
400 | { | When invalid website is provided |
401 | { | When API key is unauthorized |
429 | { | When the rate limit is exceeded |
500 | { | When server error occurs |
