put https://api.gupshup.io/wa/app//business/profile
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 | { "profile": { "addressLine1": "<business_address>", "addressLine2": "<business_address>", "city": "", "country": "", "desc": "<business_description>", "pinCode": "<city_pincode>", "profileEmail": "<business_email>", "state": "", "vertical": "<business_type>", "website1": "<business_website>", "website2": "<business_website>" }, "status": "success" } | |
| Error | ||
| 400 | { "status": "error", "message": "Invalid app id provided" } | When invalid/empty appId is provided |
| 400 | { "status": "error", "message": "app is not live" } | When app is not live |
| 400 | { "status": "error", "message": "Unable to Authenticate Docker" } | When docker authentication fails |
| 400 | { "status": "error", "error": "" } | When Facebook returns error while setting business profile details |
| 400 | { "status": "error", "message": "vertical can't be empty" } | When vertical field is empty |
| 400 | { "status": "error", "message": "Invalid Website URL" } | When invalid website is provided |
| 401 | { "status": "error", "message": "Authentication Failed" } | When API key is unauthorized |
| 429 | { "status": "error", "message": "Too Many Requests" } | When the rate limit is exceeded |
| 500 | { "status": "error", "message": "unable to update profile details" } | When server error occurs |