On-Premises API

We are sunsetting On-Premises API. Refer to our On-Premises API Sunset document for details, and to learn how to migrate to our next-generation Cloud API.

Business Profile Settings

/v1/settings/business/profile

Use the /v1/settings/business/profile endpoint to configure the following business profile settings: business address, business description, email for business contact, business industry, and business website.

Before You Start

  • You must use the admin account to access the business profile settings.

Retrieving

Make a GET API call to retrieve your business profile settings.

Example

GET /v1/settings/business/profile

A successful response includes the profile object containing the business profile data. For more description of the data, see the Parameters list below.

{
   "settings": {
     "business": {
        "profile": {
          "address": "new-business-address",
          "description": "business-description",
          "email": "new-business-email",
          "vertical": "business-industry",
          "websites": [ "website-1", "website-2" ]
        }
      }
}

If you encounter any errors, see Error and Status Messages.

Updating Business Profile Settings

Make a POST API call to update your business profile settings.

Example

POST /v1/settings/business/profile
{
    "address": "your-business-address",
    "description": "your-business-description",
    "email": "your-business-email",
    "vertical": "your-business-industry",
    "websites": [ "your-website-1", "your-website-2" ]
}

Parameters

NameDescription

address

type: String

Address of the business. Maximum of 256 characters.

description

type: String

Description of the business. Maximum of 512 characters.

email

type: String

Email address (in valid email format) to contact the business. Maximum of 128 characters.

vertical

type: String

Industry of the business. Must be one of these accepted values:

  • 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

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 each.

Partial updates

If you only need to update a couple of fields with new information, you can make a request which changes only the necessary fields:

  POST /v1/settings/business/profile
{
    "address": "new-business-address",
    "email": "new-business-email"
}

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