Skip to main content
PUT
Update Business

Headers

Accept
string
default:application/json

e.g. application/json

x-api-key
string

e.g. [Required] Partner specific API key provided by Birdeye for data exchange.

Content-Type
string
default:application/json

Media type of the JSON request body.

Path Parameters

businessId
string
required

The Business Number

Body

application/json
emailId
string
required

Business Email ID.

phone
string
required

Business Phone (Required) Format is (xxx) xxx-xxxx.

services
string
required

Services (Comma separated list of services offered; used for SEO).

name
string

Name of the Business/Product (Max 250 character long).

alias
string

Alias, Your internal way of identifying this location.

isAddressHidden
number

If your business doesn’t have a place for your customers to visit, then you can hide your street address. 1 -> hide, 0 -> unhide (Note that this isn’t supported by all sites).

location
object

Business address

fax
string

Fax number Format is (xxx) xxx-xxxx.

websiteUrl
string

Business website url.

establishedYear
number

Year established

timezone
string

Timezone of the business.

languages
any[]

Language.

isServiceAreaProvider
string

To select whether the business is Service Area Business Type. Default value is : No.

serviceAreas
object[]

Service Area information. You can enter upto 10 service area addresses in one request

working24x7
number

Whether business is 24x7 open or not (0-false, 1-true).

hoursOfOperations
object[]

Working hours of business for each day.

specialHours
object[]

Special hours of business.

businessStatus
string

The business status on the listing page can be set to Open, Temporarily Closed, Permanently Closed, or Opening Soon. A Reopen Date is mandatory for 'Temporarily Closed' and 'Opening Soon' statuses, while optional for 'Open'.

reopenDate
string

Reopen Date is required for the 'Temporarily Closed' and 'Opening Soon' statuses, and optional for 'Open.' The date must be in the 'MM/dd/yyyy' format.

keywords
string

Keywords about the business. Useful in SEO. Business keyword cannot be more than 1000 characters.

products
string

Let customers book appointments by redirecting them to your appointments page.

Let customers reserve tables by linking them to your reservations page.

Show customers what you serve by linking them to your menu.

Let customers place delivery and pick-up orders by linking them to your ordering page.

impressum
string

In certain countries (like Austria, Germany and Switzerland), businesses may be required by law to include a statement of ownership on their web presence.

payment
string

Payment Type (Max 250 character long).

localPhoneNumber
string

Local phone number.

tollFreePhoneNumber
string

Tollfree number.

androidAppURL
string

Android app url.

iosAppURL
string

IOS app url.

logoUrl
string

Logo Image. Minimum 250 x 250px. Recommended: 720 X 720 px. 10 KB min.

gmbLogoOptOut
number

Update profile photo on your google my business page. (1-false,0-true).

fbLogoOptOut
number

Update profile photo on your facebook profile. (1-false,0-true).

gmbCoverOptOut
number

Update cover photo on your google my business page. (1-false,0-true).

fbCoverOptOut
number

Update cover photo on your facebook profile. (1-false,0-true).

coverImageUrl
string

Cover image URL for business displayed on custom review site. Format: JPG, JPEG, PNG. Minimum 1296 x 367px.

gmbCover
string

Google Cover Image Url.

facebookCover
string

Facebook Cover Image Url.

coverBusinessInfoLayout
string

Show on your Birdeye profile. Possible value will be

covidInfo
object

Provide covid related update in.

bingListing
object

Provide bing data for listing purpose.

internalListing
object

Provide data for microsite listing purpose.

facebookListing
object

Provide data for facebook listing purpose.

gmbListing
object

Provide data for gmb listing purpose.

socialProfileURLs
object

Profile URLs for business on top rated social sites

isSEOEnabled
boolean

Enable/Disbale search engine indexing of business profile. Valid values are "true","false". Default is "true".

externalReferenceId
string

It should be a unique value for location identifier.

customFields
object

Custom Field To be Updated

entityCategory
string

Specifies the category of the business entity being created or updated. Valid values are:

Response

OK

name
string
alias
string
emailId
string
phone
string
fax
string
websiteUrl
string
description
string
keywords
string
services
string
logoUrl
string
coverImageUrl
string
gmbCover
string
facebookCover
string
timezone
string
languages
string[]
isServiceAreaProvider
string
serviceAreas
object[]
payment
string
hoursOfOperations
object[]
working24x7
number
location
object
categoryList
string[]
socialProfileURLs
object