Skip to main content
POST
Create a business

Headers

Accept
string

e.g. application/json

x-api-key
string

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

Query Parameters

rid
number
required

Id of the Reseller.

email_id
string
required

Business Email id.

Body

application/json
businessName
string
required

Name of the Business that needs to be added

zip
string
required

Postal code of the business location

phone
number
required

Phone number of the Business.

type
string

Type of the Business. Valid values are

entityCategory
string

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

physical_location,provider. physical_location represents a physical office, branch, or storefront location. provider represents an individual practitioner or provider (e.g. doctor, dentist, loan officer) operating within one or more physical locations. If entityCategory is not provided, the entity is created as physical_location by default.

countryCode
string

This field is mandatory for non US locations.

aggrOptions
number

Aggregation Options to enable/disable aggregations. Possible values are [0,1]

If aggrOptions is not provided, then Search Business is enabled.

Response

OK

businessId
number

Id of the created business