Set Business Profile

POST {{URL}}/v1/settings/business/profile

Make a POST API call to the /v1/settings/business/profile endpoint to update your business profile settings.

Request Parameters

Name Description
address
Type: String
The address of the business. Maximum of 256 characters .
description
Type: String
The description of the business. Maximum of 256 characters .
email
Type: String
The email address (in valid email format) to contact the business. Maximum of 128 characters .
vertical
Type: String
The industry of the business. The value must be one of the following:
  • Automotive
  • Beauty, Spa, and Salon
  • Clothing and Apparel
  • Education
  • Entertainment
  • Event Planning and Service
  • Finance and Banking
  • Food and Grocery
  • Public Service
  • Hotel and Lodging
  • Medical and Health
  • Non-profit
  • Professional Services
  • Shopping and Retail
  • Travel and Transportation
  • Restaurant
  • Other


The business vertical cannot be set back to an empty value after it is created.
websites
Type: Array of Strings
The URLs (including http:// or https:// ) associated with the business (e.g., website, Facebook Page, Instagram). Maximum of 2 websites with a maximum of 256 characters .

A successful request returns the HTTP Status Code 200 OK and either null or {} . If you encounter any errors, see Error and Status Messages .

Request Body

{"address"=>"{{Business Profile Address}}", "description"=>"{{Business Profile Description}}", "email"=>"{{Business Profile Email}}", "vertical"=>"{{Business Profile Vertical}}", "websites"=>["https://www.whatsapp.com", "https://www.facebook.com"]}

HEADERS

| Key | Datatype | Required | Description | | Content-Type | string | | | | Authorization | string | | |

RESPONSES

status: OK

{"meta":{"api_status":"stable","version":"v2.45.1"}}