Skip to main content
POST
Create New Competitor Enterprise

Headers

Accept
string

e.g. application/json

x-api-key
string

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

Path Parameters

businessNumber
string
required

Account Business Number.

Body

application/json
businessName
string

Location competitor name.

userEmailId
string

Location user email.

countryCode
string

Location country code.

phone
string

234-5272 (string) - Location phone number.

zip
string

Zip code.

competitorId
string

Competitor Id.

type
string

Business type.

Response

OK

competitorId
number

Enterprise Competitor Business ID.

Example:

100037739

templateid
number

Template Id.

isAggregationRequired
number

Is agrgegation required.

Example:

1

type
string

Location-Competitor (string) - Type.

Example:

"Enterprise"

businessNumber
number

Enterprise Competitor Business Number.

Example:

169744180007807

businessAlreadyPresent
boolean

Is Business Already Present.