apiary.apib

FORMAT: 1A
HOST: https://api.birdeye.com/resources

# Birdeye
Birdeye helps businesses grow through happy customers. Over 80,000 businesses use Birdeye everyday to attract new leads with Listings, Reviews and Referrals, convert them into customers with Webchat, Appointments, and Payments, and delight those customers with Surveys, Ticketing, and Insights - all in one place.

The Birdeye APIs are built on HTTP and are RESTful APIs.

* Uses resource-oriented URLs.
* Uses built-in HTTP capabilities for passing parameters and authentication.
* Responds with standard HTTP response codes to indicate errors.
* Requests and responses payload attached with all the mentioned APIs, you may choose your preferred language per the integration requirement.

### Authentication and Rate limiting

> __NOTE:__
> - __All API requests targeting business accounts must include the x-api-key header. This header is required and mandatory for successful authentication and access to the API endpoints.__
>
> - __To protect your API key and prevent unauthorized access, please ensure all API requests are made from your backend server. Do not call the APIs directly from the browser or expose your API key in any client-side code.__

To call a Birdeye API, you need a valid API key. It can be fetched via the Birdeye dashboard and is a confidential key.

There is a limit to calling APIs with each API key [connect with the support team to get the current limit]. If too many requests are made within the threshold timeframe, an error will be returned in the response.




### Pagination

Multiple API supporting pagination. These APIs have two parameters sindex and count.


* <b>sindex:</b> is the start index
* <b>count:</b> No. of records, you want to fetch.


> __Note__
> - _Deep Pagination with record window greater than 100k is not supported. Either reduce the sindex + count to be less than equal to 100k or use appropriate filters to narrow down your result set._



<b>For example :</b>

* Suppose you have to fetch 20 records:
<pre><code>
API call 1 -> sindex=0, count 10
API call 2 -> sindex -> 10, count 10.
</pre></code>

* To fetch 100kth record:
<pre><code>
sindex = 99000 and count = 1000
will just work fine as sindex + count = 100000 which is less than 100,000.
</pre></code>

* If you fetch more than 100kth records:
<pre><code>
sindex = 99000 and count = 1001, sindex + count = 100001
which is greater than 100,000. Thus, you'll receive an error in response.
</pre></code>

### HTTP Status Codes
Every API response will have an HTTP status code.

* <b>200 - OK:</b> API request is successful
* <b>202 - Accepted:</b> The API request has been accepted for processing.
* <b>400 - Bad Request:</b> The API request was unacceptable, often due to a missing or invalid parameter.
* <b>404 - Not Found:</b> The requested resource does not exist.
* <b>429 - Rate Limited:</b> You have made too many requests within the threshold timeframe.
* <b>500 - Internal Server Error:</b> Something went wrong on our end. Please get in touch with support.

### Error Response

Birdeye API will return a validation error in case of missing/invalid input in the request. The response will return the errorCode and errorMessage.

For example :
<pre><code>
{
    "code": 1161,
    "message": "Invalid API key"
}
</pre></code>


## 1023 [/1023]

+ Model (application/json)

        {
            "code": 1023,
            "message": "No email addresses specified"
        }

## 1052 [/1052]

+ Model (application/json)

        {
            "code": 1052,
            "message": "User email id cannot be blank"
        }

## 1150 [/1150]

+ Model (application/json)

        {
            "code": 1150,
            "message": "Business already associated with this reseller"
        }

## 1151 [/1151]

+ Model (application/json)

        {
            "code": 1151,
            "message": "Business already associated with another reseller"
        }

## 1040 [/1040]

+ Model (application/json)

        {
            "code": 1040,
            "message": "Invalid temmplate id."
        }

## 1045 [/1045]

+ Model (application/json)

        {
            "code": 1045,
            "message": "Business name cannot be blank"
        }

## 1046 [/1046]

+ Model (application/json)

        {
            "code": 1046,
            "message": "Business name cannot be more than 250 characters"
        }

## 1047 [/1047]

+ Model (application/json)

        {
            "code": 1047,
            "message": "Business name cannot be less than 3 characters"
        }

## 1094 [/1094]

+ Model (application/json)

        {
            "code": 1094,
            "message": "Postal code cannot be blank."
        }

## 1030 [/1030]

+ Model (application/json)

        {
            "code": 1030,
            "message": "URL cannot be blank"
        }

## 1031 [/1031]

+ Model (application/json)

        {
            "code": 1031,
            "message": "Source id cannot be blank"
        }

## 1032 [/1032]

+ Model (application/json)

        {
            "code": 1032,
            "message": "Invalid source id"
        }

## 1039 [/1039]

+ Model (application/json)

        {
            "code": 1039,
            "message": "Invalid business aggregation id"
        }

## 1067 [/1067]

+ Model (application/json)

        {
            "code": 1067,
            "message": "URL is invalid"
        }

## 1075 [/1075]

+ Model (application/json)

        {
            "code": 1075,
            "message": "Business location zip cannot be more than 6 numbers"
        }

## 1025 [/1025]

+ Model (application/json)

        {
            "code": 1025,
            "message": "Invalid business type"
        }

## 1161 [/1161]

+ Model (application/json)

        {
            "code": 1161,
            "message": "Invalid API key"
        }

## 1167 [/1167]

+ Model (application/json)

        {
            "code": 1167,
            "message": "API key is missing"
        }

## 89 [/89]
+ Model (application/json)

        {
            "code": 89,
            "message": "Rate limit exceeded"
        }

## 1033 [/1033]

+ Model (application/json)

        {
            "code": 1033,
            "message": "You are not authorized to perform this action"
        }

## 1175 [/1175]

+ Model (application/json)

        {
            "code": 1175,
            "message": "No business found with the given id"
        }

##  1010 [/1010]

+ Model (application/json)

        {
            "code": 1010,
            "message": "No user found with the given id"
        }

## 1076 [/1076]

+ Model (application/json)

        {
            "code": 1176,
            "message": "Business info cannot be blank"
        }

## 1162 [/1162]

+ Model (application/json)

        {
            "code": 1162,
            "message": "Either search string or location or both should be specified"
        }

## 1163 [/1163]

+ Model (application/json)

        {
            "code": 1163,
            "message": "Invalid start index value"
        }

## 1164 [/1164]

+ Model (application/json)

        {
            "code": 1164,
            "message": "Invalid result count value"
        }

## 1011 [/1011]

+ Model (application/json)

        {
            "code": 1011,
            "message": "Business id is invalid"
        }

## 1380 [/1380]

+ Model (application/json)

        {
            "code": 1380,
            "message": "Api key or session token missing"
        }

## 1048 [/1048]

+ Model (application/json)

        {
            "code": 1048,
            "message": "Business email id cannot be blank."
        }

## 1049 [/1049]

+ Model (application/json)

        {
            "code": 1049,
            "message": "Business email id is invalid."
        }

## 1050 [/1050]

+ Model (application/json)

        {
            "code": 1050,
            "message": "Business email id cannot be more than 40 characters."
        }

## 1055 [/1055]

+ Model (application/json)

        {
            "code": 1055,
            "message": "Not a valid US phone number."
        }

## 1056 [/1056]

+ Model (application/json)

        {
            "code": 1056,
            "message": "Not a valid US fax number."
        }


## 1069 [/1069]

+ Model (application/json)

        {
            "code": 1069,
            "message": "Business description cannot be more than 4000 characters."
        }

## 1070 [/1070]

+ Model (application/json)

        {
            "code": 1070,
            "message": "Business keywords cannot be more than 1000 characters."
        }

## 1089 [/1089]

+ Model (application/json)

        {
            "code": 1089,
            "message": "Customer id is invalid."
        }

## 1091 [/1091]

+ Model (application/json)

        {
            "code": 1091,
            "message": "User id not authorized to view this customer."
        }

## 1190 [/1190]

+ Model (application/json)

        {
            "code": 1190,
            "message": "Invalid category"
        }

## 1184 [/1184]

+ Model (application/json)

        {
            "code": 1184,
            "message": "Status change is not allowed"
        }

## 1191 [/1191]

+ Model (application/json)

        {
            "code": 1191,
            "message": "Invalid status."
        }

## 1174 [/1174]

+ Model (application/json)

        {
            "code": 1174,
            "message": "Reseller can't be removed as it has child accounts."
        }

## 1160 [/1160]

+ Model (application/json)

        {
            "code": 1160,
            "message": "User is already associated with business."
        }

## 1053 [/1053]

+ Model (application/json)

        {
            "code": 1053,
            "message": "User email id is invalid"
        }

## 1054 [/1054]

+ Model (application/json)

        {
            "code": 1054,
            "message": "User email id cannot be more than 40 characters"
        }

## 1014 [/1014]

+ Model (application/json)

        {
            "code": 1014,
            "message": "User role cannot be blank"
        }


## 1013 [/1013]

+ Model (application/json)

        {
            "code": 1013,
            "message": "Unknown user role"
        }


## 1057 [/1057]

+ Model (application/json)

        {
            "code": 1057,
            "message": "First name cannot be more than 50 characters"
        }

## 1059 [/1059]

+ Model (application/json)

        {
            "code": 1059,
            "message": "Last name cannot be more than 50 characters"
        }

## 1188 [/1188]

+ Model (application/json)

        {
            "code": 1188,
            "message": "User is not associated with the business."
        }


## 1189 [/1189]

+ Model (application/json)

        {
            "code": 1189,
            "message": "User with given email id not found."
        }

## 1177 [/1177]

+ Model (application/json)

        {
            "code": 1177,
            "message": "User is not authorized to perform any action on any business"
        }

## 1081 [/1081]

+ Model (application/json)

        {
            "code": 1081,
            "message": "Review comment is too long"
        }


## 1082 [/1082]

+ Model (application/json)

        {
            "code": 1082,
            "message": "Review rating is missing"
        }

## 1142 [/1142]

+ Model (application/json)

        {
            "code": 1142,
            "message": "Customer name cannot be blank"
        }


## 1086 [/1086]

+ Model (application/json)

        {
            "code": 1086,
            "message": "Customer email id cannot be blank."
        }

## 1087 [/1087]

+ Model (application/json)

        {
            "code": 1087,
            "message": "Customer email id is invalid."
        }

## 1088 [/1088]

+ Model (application/json)

        {
            "code": 1088,
            "message": "Customer email id cannot be more than 40 characters."
        }

## 1170 [/1170]

+ Model (application/json)

        {
            "code": 1170,
            "message": "SMS Alert flag is invalid. Valid values are 0 or 1."
        }

## 1242 [/1242]

+ Model (application/json)

        {
            "code": 1242,
            "message": "Invalid rating value. Allowed value between 0-5."
        }


## 1228 [/1228]

+ Model (application/json)

        {
            "code": 1228,
            "message": "Invalid updated to date. Allowed format is MM/dd/yyyy"
        }

## 1227 [/1227]

+ Model (application/json)

        {
            "code": 1227,
            "message": "Invalid updated from date. Allowed format is MM/dd/yyyy"
        }


## 1243 [/1243]

+ Model (application/json)

        {
            "code": 1243,
            "message": "Invalid rating value. Allowed value between 1-5."
        }

## 1244 [/1244]

+ Model (application/json)

        {
            "code": 1244,
            "message": "Maximum 5 keywords can be selected for filter."
        }

## 1246 [/1246]

+ Model (application/json)

        {
            "code": 1246,
            "message": "Customer email or phone number is required."
        }

## 1215 [/1215]

+ Model (application/json)

        {
            "code": 1215,
            "message": "Invalid report month."
        }

## 1251 [/1251]

+ Model (application/json)

        {
            "code": 1251,
            "message": "No review to mark featured/un-featured."
        }

## 1042 [/1042]

+ Model (application/json)

        {
            "code": 1042,
            "message": "Invalid review id"
        }

## 1252 [/1252]

+ Model (application/json)

        {
            "code": 1252,
            "message": "Review does not belong to the business."
        }

## 1248 [/1248]

+ Model (application/json)

        {
            "code": 1248,
            "message": "Allowed limit for featured reviews exceeded."
        }

## 1186 [/1186]

+ Model (application/json)

        {
            "code": 1186,
            "message": "Invalid from date. Allowed format is "MM/dd/yyyy"."
        }

## 1187 [/1187]

+ Model (application/json)

        {
            "code": 1187,
            "message": "Invalid to date. Allowed format is "MM/dd/yyyy"."
        }

## 1265 [/1265]

+ Model (application/json)

        {
            "code": 1265,
            "message": "Value for showOnFacebook is mandatory."
        }

## 1266 [/1266]

+ Model (application/json)

        {
            "code": 1266,
            "message": "Value for showOnProfile is mandatory."
        }

## 1267 [/1267]

+ Model (application/json)

        {
            "code": 1267,
            "message": "Value for showOnWebsite is mandatory."
        }

## 1268 [/1268]

+ Model (application/json)

        {
            "code": 1268,
            "message": "TabType is mandatory field."
        }

## 1269 [/1269]

+ Model (application/json)

        {
            "code": 1269,
            "message": "Max length for lable is 30."
        }

## 1270 [/1270]

+ Model (application/json)

        {
            "code": 1270,
            "message": "Max length for URL is 1000."
        }

## 1360 [/1360]

+ Model (application/json)

        {
            "code": 1360,
            "message": "Hierarchy is not supported for this parent type."
        }

## 1361 [/1361]

+ Model (application/json)

        {
            "code": 1361,
            "message": "Hierarchy is not supported for this child type."
        }

## 1362 [/1362]

+ Model (application/json)

        {
            "code": 1362,
            "message": "{Child type} cannot be added under {Parent type}."
        }

## 1363 [/1363]

+ Model (application/json)

        {
            "code": 1363,
            "message": "Invalid parent child mapping."
        }


## 1029 [/1029]

+ Model (application/json)

        {
            "code": 1029,
            "message": "Aggregation source not found"
        }

## 1315 [/1315]

+ Model (application/json)

        {
            "code": 1315,
            "message": "Invalid survey."
        }

## 1523 [/1523]

+ Model (application/json)

        {
            "code": 1523,
            "message": "The correct date format should be mm/dd/yyyy."
        }


## 1524 [/1524]

+ Model (application/json)

        {
            "code": 1524,
            "message": "Date entered is invalid."
        }

## 2110 [/2110]

+ Model (application/json)

        {
            "code": 2110,
            "message": "Your review response could not be submitted due to a temporary error on Google. Please try after some time."
        }

## 21101 [/21101]

+ Model (application/json)

        {
            "code": 21101,
            "message": "Google page is not integrated. Kindly integrate it first."
        }

## 21103 [/21103]

+ Model (application/json)

        {
            "code": 21103,
            "message": "Your review response could not be submitted due to a temporary error on Google."
        }

## 21104 [/21104]

+ Model (application/json)

        {
            "code": 21104,
            "message": "Sorry, We could not find this review on Google. Please go to your Google Business page and reply to this review. Thank you."
        }

## 2111 [/2111]

+ Model (application/json)

        {
            "code": 2111,
            "message": "Your review response could not be submitted due to a temporary error on Facebook. Please try after some time."
        }

## 21113 [/21113]

+ Model (application/json)

        {
            "code": 21113,
            "message": "Facebook page is not integrated. Kindly integrate it first."
        }

## 21114 [/21114]

+ Model (application/json)

        {
            "code": 21114,
            "message": "Sorry, We could not find this review on Facebook. Please go to your Facebook page and reply to this review. Thank you."
        }

## 21112 [/21112]

+ Model (application/json)

        {
            "code": 21112,
            "message": "Your review response could not be submitted due to a temporary error on Facebook."
        }

## 2222 [/2222]

+ Model (application/json)

        {
            "code": 2222,
            "message": "Oops! Something is off on our side. We are working on it. Please check later."
        }

## 2075 [/2075]

+ Model (application/json)

        {
            "code": 2075,
            "message": "Error while claiming a provider for Care Dash"
        }

## 20706 [/20706]

+ Model (application/json)

        {
            "code": 20706,
            "message": "Error while posting a reply to Care Dash"
        }

## 2078 [/2078]

+ Model (application/json)

        {
            "code": 2078,
            "message": "Error while posting a reply to Rent"
        }

## 1541 [/1541]

+ Model (application/json)

        {
            "code": 1541,
            "message": "Rate Limit of API has been exceeded."
        }

## 1532 [/1532]

+ Model (application/json)

        {
            "code": 1532,
            "message": "Business id is missing or invalid."
        }

## 5008 [/5008]

+ Model (application/json)

        {
            "code": 5008,
            "message": "RequestBody not found"
        }

## 5043 [/5043]

+ Model (application/json)

        {
            "code": 5043,
            "message": "Contact not found for the given request"
        }

## 2038 [/2038]

+ Model (application/json)

        {
            "code": 2038,
            "message": "Invalid value of role, expected editor, viewer or no-access"
        }

## 2041 [/2041]

+ Model (application/json)

        {
            "code": 2041,
            "message": "Can't modify owner or existing owner's access!"
        }

## 2039 [/2039]

+ Model (application/json)

        {
            "code": 2039,
            "message": "User email is missing in user access request!"
        }

## 2043 [/2043]

+ Model (application/json)

        {
            "code": 2043,
            "message": "Invalid value of showTitle, accepted values are CUSTOM, LOCATION, OFF"
        }

## 2090 [/2090]

+ Model (application/json)

        {
            "code": 2090,
            "message": "Invalid value of showLogo, accepted values are ON, OFF"
        }

## 2040 [/2040]

+ Model (application/json)

        {
            "code": 2040,
            "message": "Invalid value of progress bar position, expected Bottom or Top"
        }

## 2042 [/2042]

+ Model (application/json)

        {
            "code": 2042,
            "message": "Received no valid inputs in request body!"
        }

## 2037 [/2037]

+ Model (application/json)

        {
            "code": 2037,
            "message": "The survey doesn't belong to the account."
        }

## 2044 [/2044]

+ Model (application/json)

        {
            "code": 2044,
            "message": "Survey already completed"
        }

## 2093 [/2093]

+ Model (application/json)

        {
            "code": 2093,
            "message": "Survey Field Type passed is unknown"
        }

## 2045 [/2045]

+ Model (application/json)

        {
            "code": 2045,
            "message": "Invalid Survey Type"
        }

## 2046 [/2046]

+ Model (application/json)

        {
            "code": 2046,
            "message": "Min Value is greater then Max Value"
        }

## 2047 [/2047]

+ Model (application/json)

        {
            "code": 2047,
            "message": "Survey Fields Missing!"
        }

## 2048 [/2048]

+ Model (application/json)

        {
            "code": 2048,
            "message": "Field Rows Missing"
        }

## 2049 [/2049]

+ Model (application/json)

        {
            "code": 2049,
            "message": "Interval can only be 30 min or 60 min"
        }

## 2050 [/2050]

+ Model (application/json)

        {
            "code": 2050,
            "message": "More than one location question cannot be present"
        }

## 2051 [/2051]

+ Model (application/json)

        {
            "code": 2051,
            "message": "More than one review question cannot be present"
        }

## 2052 [/2052]

+ Model (application/json)

        {
            "code": 2052,
            "message": "Review question should be present in the last page of the survey as a single question"
        }

## 2053 [/2053]

+ Model (application/json)

        {
            "code": 2053,
            "message": "Contact Fields are not present"
        }

## 2054 [/2054]

+ Model (application/json)

        {
            "code": 2054,
            "message": "Min Value out of range"
        }

## 2055 [/2055]

+ Model (application/json)

        {
            "code": 2055,
            "message": "Max Value out of range"
        }

## 2056 [/2056]

+ Model (application/json)

        {
            "code": 2056,
            "message": "Min and Max values can only be even numbers when the interval is 60 minutes"
        }

## 2057 [/2057]

+ Model (application/json)

        {
            "code": 2057,
            "message": "Either one of Min and Max values is missing in datetime type question"
        }

## 2058 [/2058]

+ Model (application/json)

        {
            "code": 2058,
            "message": "LocationIds are not present"
        }

## 2059 [/2059]

+ Model (application/json)

        {
            "code": 2059,
            "message": "Invalid type of contact question"
        }

## 2060 [/2060]

+ Model (application/json)

        {
            "code": 2060,
            "message": "reviewSources are not present for review type question"
        }

## 2061 [/2061]

+ Model (application/json)

        {
            "code": 2061,
            "message": "Pickone type of survey can only contain pickone type questions"
        }

## 2062 [/2062]

+ Model (application/json)

        {
            "code": 2062,
            "message": "Traditional type survey cannot contain these type questions"
        }

## 2063 [/2063]

+ Model (application/json)

        {
            "code": 2063,
            "message": "Pulse(NPS) Survey can only contain radio, text, textarea(paragraph), rating and nps type questions"
        }

## 2064 [/2064]

+ Model (application/json)

        {
            "code": 2064,
            "message": "First page of the survey must contain atleast one question except review question"
        }

## 2065 [/2065]

+ Model (application/json)

        {
            "code": 2065,
            "message": "There cannot be more than 3 sourceIds for review question"
        }

## 2066 [/2066]

+ Model (application/json)

        {
            "code": 2066,
            "message": "BusinessIds passed in the location type question are invalid"
        }

## 2067 [/2067]

+ Model (application/json)

        {
            "code": 2067,
            "message": "One of the locations passed in the request is not present"
        }

## 2068 [/2068]

+ Model (application/json)

        {
            "code": 2068,
            "message": "The locationIds are Non-Parseable"
        }

## 2069 [/2069]

+ Model (application/json)

        {
            "code": 2069,
            "message": "surveyName is Mandatory"
        }

## 2070 [/2070]

+ Model (application/json)

        {
            "code": 2070,
            "message": "Question Type cannot be blank"
        }

## 2071 [/2071]

+ Model (application/json)

        {
            "code": 2071,
            "message": "Invalid ownerEmailId"
        }

## 2072 [/2072]

+ Model (application/json)

        {
            "code": 2072,
            "message": "Choice cannot be a blank string"
        }

## 2073 [/2073]

+ Model (application/json)

        {
            "code": 2073,
            "message": "Logic type is Invalid!"
        }

## 2074 [/2074]

+ Model (application/json)

        {
            "code": 2074,
            "message": "Cannot contain a logic"
        }

## 2092 [/2092]

+ Model (application/json)

        {
            "code": 2092,
            "message": "Invalid Logic!"
        }

## 2076 [/2076]

+ Model (application/json)

        {
            "code": 2076,
            "message": "Value of the logic is not present in the choices of Question"
        }

## 2077 [/2077]

+ Model (application/json)

        {
            "code": 2077,
            "message": "Value of a questionLogic field cannot be blank"
        }

## 2091 [/2091]

+ Model (application/json)

        {
            "code": 2091,
            "message": "Operator Invalid"
        }

## 2079 [/2079]

+ Model (application/json)

        {
            "code": 2079,
            "message": "Only one Skip logic is allowed for text and textarea type questions"
        }

## 2080 [/2080]

+ Model (application/json)

        {
            "code": 2080,
            "message": "Display Logic Invalid!"
        }

## 2081 [/2081]

+ Model (application/json)

        {
            "code": 2081,
            "message": "Skip Logic Invalid!"
        }

## 2082 [/2082]

+ Model (application/json)

        {
            "code": 2082,
            "message": "The API returned an empty response."
        }

## 2083 [/2083]

+ Model (application/json)

        {
            "code": 2083,
            "message": "Source is not integrated with the business"
        }

## 2084 [/2084]

+ Model (application/json)

        {
            "code": 2084,
            "message": "Opeartor must be present for logics other than the first display logic"
        }

## 2085 [/2085]

+ Model (application/json)

        {
            "code": 2085,
            "message": "Condition cannot be null!"
        }

## 2086 [/2086]

+ Model (application/json)

        {
            "code": 2086,
            "message": "Question Number cannot be null"
        }

## 2087 [/2087]

+ Model (application/json)

        {
            "code": 2087,
            "message": "Duplicate contact sub type question is present"
        }

## 2088 [/2088]

+ Model (application/json)

        {
            "code": 2088,
            "message": "Review Source already present"
        }

## 2094 [/2094]

+ Model (application/json)

        {
            "code": 2094,
            "message": "ReviewSources passed are invalid"
        }

## 2095 [/2095]

+ Model (application/json)

        {
            "code": 2095,
            "message": "ownerEmailId cannot be null"
        }

## 2096 [/2096]

+ Model (application/json)

        {
            "code": 2096,
            "message": "Detected conflicting user-access request!"
        }

## 2347 [/2347]

+ Model (application/json)

        {
            "code": 2347,
            "message": "Max page size allowed is 1,000"
        }



## 2348 [/2348]

+ Model (application/json)

        {
            "code": 2348,
            "message": "Max window size allowed is 60000 for a filter selection"
        }

## 21122 [/21122]

+ Model (application/json)

        {
            "code": 21122,
            "message": "Reseller business is not supported in this request"
        }

## 21120 [/21120]

+ Model (application/json)

        {
            "code": 21120,
            "message": "Invalid contact type provided in the request. Valid contact types are lead or customer"
        }

## 21121 [/21121]

+ Model (application/json)

        {
            "code": 21121,
            "message": "Invalid contact source provided in the request."
        }

## 5046 [/5046]

+ Model (application/json)

        {
            "code": 5046,
            "message": "The customer is blocked"
        }

## 1021 [/1021]

+ Model (application/json)

        {
            "code": 1021,
            "message": "Invalid Phone Number."
        }

## 1001 [/1001]

+ Model (application/json)

        {
            "code": 1001,
            "message": "Name of the contact is too long."
        }


## 1422 [/1422]

+ Model (application/json)

        {
            error"code": 1422,
            error"message": "Api call failed"
        }


## 5556 [/5556]

+ Model (application/json)

        {
            "code": 5556,
            "message": "One or few BusinessIds are Invalid"
        }


## 5557 [/5557]

+ Model (application/json)

        {
            "code": 5557,
            "message": "Requested Business Ids are empty."
        }

## 400 [/400]

+ Model (application/json)

        {
            "code": 400,
            "message": "Page size must not be less than one!"
        }


## 4011 [/4011]

+ Model (application/json)

        {
            "code": 400,
            "message": "Category Id not found"
        }

## 4012 [/4012]

+ Model (application/json)

        {
            "code": 400,
            "message": "Country code not found"
        }

## 4013 [/4013]

+ Model (application/json)

        {
            "code": 400,
            "message": "Invalid country code"
        }


## 4014 [/4014]

+ Model (application/json)

        {
            "code": 400,
            "message": "Source name not found"
        }

## 4015 [/4015]

+ Model (application/json)

        {
            "code": 400,
            "message": "Invalid Source Name"
        }


## 20083 [/20083]

+ Model (application/json)

        {
            "code": 20083,
            "message": "End date can't be before start date"
        }

## 2180 [/2180]

+ Model (application/json)

        {
            "code": 2180,
            "message": "The recommended Image size for Google media image is 250 pixels wide and 250 pixels tall."
        }

## 2181 [/2181]

+ Model (application/json)

        {
            "code": 2181,
            "message": "Supported video format is MP4."
        }

## 2174 [/2174]

+ Model (application/json)

        {
            "code": 2174,
            "message": "Unsupported media format"
        }

## 2171 [/2171]

+ Model (application/json)

        {
            "code": 2171,
            "message": "URL is invalid"
        }

## 2175 [/2175]

+ Model (application/json)

        {
            "code": 2175,
            "message": "Provided media category is not supported"
        }


## 2270 [/2270]

+ Model (application/json)

        {
            "code": 2270,
            "message": "Unsupported Media Category for the business"
        }


## 2176 [/2176]

+ Model (application/json)

        {
            "code": 400,
            "message": "Category can not be empty"
        }

## 2457 [/2457]

+ Model (application/json)

        {
            "code": 2457,
            "message": "Invalid sortby value. Allowed values are 'frequency' or 'keyword'"
        }

## 2458 [/2458]

+ Model (application/json)

        {
            "code": 2458,
            "message": "Invalid order value. Allowed values are 'asc' or 'desc'."
        }

## 2177 [/2177]

+ Model (application/json)

        {
            "code": 400,
            "message": "Invalid media id"
        }

## 2178 [/2178]

+ Model (application/json)

        {
            "code": 400,
            "message": "mediaIds can not be empty"
        }

## 1093 [/1093]

+ Model (application/json)

        {
            "code": 1093,
            "message": "HierarchyNode is enabled for this account."
        }

## 2150 [/2150]

+ Model (application/json)

        {
            "code": 2150,
            "message": "Not a valid reseller/enterprise id."
        }

## 2151 [/2151]

+ Model (application/json)

        {
            "code": 2151,
            "message": "Not a valid reseller/enterprise id."
        }

## 2152 [/2152]

+ Model (application/json)

        {
            "code": 2152,
            "message": "Not a valid reseller/enterprise id."
        }

## 2153 [/2153]

+ Model (application/json)

        {
            "code": 2153,
            "message": "Business name should not have the word Birdeye."
        }

## 2154 [/2154]

+ Model (application/json)

        {
            "code": 2154,
            "message": "Business is already an active account."
        }

## 2155 [/2155]

+ Model (application/json)

        {
            "code": 2155,
            "message": "Business is already an in-active account."
        }

## 2156 [/2156]

+ Model (application/json)

        {
            "code": 2156,
            "message": "Business/Location/Product already exists"
        }


## 2157 [/2157]

+ Model (application/json)

        {
            "code": 2157,
            "message": "Business already associated with another reseller/enterprise."
        }
## 2286 [/2286]

+ Model (application/json)

        {
            "code": 2286,
            "message": "Zip code is not provided for business"
        }
## 2166 [/2166]

+ Model (application/json)

        {
            "code": 2166,
            "message": "Invalid Business Type"
        }
## 2292 [/2292]

+ Model (application/json)

        {
            "code": 2292,
            "message": "sortby can only be 'total' or 'location'"
        }
## 2293 [/2293]

+ Model (application/json)

        {
            "code": 2293,
            "message": "order can only be 'asc' or 'desc'"
        }
## 40001 [/40001]

+ Model (application/json)

        {
            "code": 40001,
            "message": "invalid start date (supported format is yyyy-MM-dd)"
        }

## 2296 [/2296]

+ Model (application/json)

        {
            "code": 2296,
            "message": "Invalid Food Delivery link"
        }

## 2297 [/2297]

+ Model (application/json)

        {
            "code": 2297,
            "message": "Invalid Food Takeout link"
        }

## 2290 [/2290]

+ Model (application/json)

        {
            "code": 2290,
            "message": "Food Takeout/Food Delivery not supported for gmb primary category"
        }

## 2476 [/2476]

+ Model (application/json)

        {
            "code": 2476,
            "message": "Question Id cannot be blank"
        }
## 2477 [/2477]

+ Model (application/json)

        {
            "code": 2477,
            "message": "Answer Id is required to update existing answer"
        }
## 2478 [/2478]

+ Model (application/json)

        {
            "code": 2478,
            "message": "Question is required"
        }
## 2479 [/2479]

+ Model (application/json)

        {
            "code": 2479,
            "message": "Answer is required"
        }
## 2480 [/2480]

+ Model (application/json)

        {
            "code": 2480,
            "message": "Cannot modify non owner Q&A"
        }
## 2482 [/2482]

+ Model (application/json)

        {
            "code": 2482,
            "message": "Question Id is Invalid"
        }
## 2481 [/2481]

+ Model (application/json)

        {
            "code": 2481,
            "message": "Q&A cannot be more than 4096 characters"
        }
## 2485 [/2485]

+ Model (application/json)

        {
            "code": 2485,
            "message": "Questions should be 10 characters minimum"
        }
## 2483 [/2483]

+ Model (application/json)

        {
            "code": 2483,
            "message": "Question should have minimum 3 words"
        }
## 2484 [/2484]

+ Model (application/json)

        {
            "code": 2484,
            "message": "Answer Id cannot be blank"
        }
## 2461 [/2461]

+ Model (application/json)

        {
            "code": 2461,
            "message": "No question found with provided request"
        }
## 2462 [/2462]

+ Model (application/json)

        {
            "code": 2462,
            "message": "Owner answer already added please edit answer"
        }
## 2466 [/2466]

+ Model (application/json)

        {
            "code": 2466,
            "message": "Invalid input request"
        }

## 2486 [/2486]

+ Model (application/json)

        {
            "code": 2486,
            "message": "Business Id missing or invalid"
        }

## 2487 [/2487]

+ Model (application/json)

        {
            "code": 2487,
            "message": "Invalid input request data"
        }

## 2488 [/2488]

+ Model (application/json)

        {
            "code": 2488,
            "message": "Invalid GBP Service name"
        }

## 2489 [/2489]

+ Model (application/json)

        {
            "code": 2489,
            "message": "Invalid GBP Service description"
        }

## 2490 [/2490]

+ Model (application/json)

        {
            "code": 2490,
            "message": "Invalid GBP Service price type"
        }

## 2491 [/2491]

+ Model (application/json)

        {
            "code": 2491,
            "message": "Invalid GBP Service price"
        }

## 2492 [/2492]

+ Model (application/json)

        {
            "code": 2492,
            "message": "Invalid GBP Service currency code"
        }

## 2493 [/2493]

+ Model (application/json)

        {
            "code": 2493,
            "message": "Duplicate Google Service is not allowed"
        }

## 2494 [/2494]

+ Model (application/json)

        {
            "code": 2494,
            "message": "Invalid GBP Service Id"
        }

## 2495 [/2495]

+ Model (application/json)

        {
            "code": 2495,
            "message": "Invalid GBP Service Id"
        }

## 2496 [/2496]

+ Model (application/json)

        {
            "code": 2496,
            "message": "Missing GBP category for given location"
        }

## 3333 [/3333]

+ Model (application/json)

        {
            "code": 1043,
            "message": "Business should be either SMB or Enterprise sub account"
        }

## 3334 [/3334]

+ Model (application/json)

        {
            "code": 2503,
            "message": "Primary category can not be included in additional category."
        }

## 3335 [/3335]

+ Model (application/json)

        {
            "code": 2276,
            "message": "Please add upto 9 GBP additional categories only."
        }

## 3336 [/3336]

+ Model (application/json)

        {
            "code": 2277,
            "message": "Duplicate GBP categories are not allowed."
        }

## 3337 [/3337]

+ Model (application/json)

        {
            "code": 2278,
            "message": "Primary GBP category is not allowed in additional GBP categories."
        }

## 3348 [/3348]

+ Model (application/json)

        {
            "code": 2162,
            "message": "Reopen date should not be less than current date."
        }

## 2511 [/2511]

+ Model (application/json)

        {
            "code": 2511,
            "message": "Cannot update business status when listing is already fixed."
        }

## 2512 [/2512]

+ Model (application/json)

        {
            "code": 2512,
            "message": "Cannot update opening soon date when listing is already fixed."
        }

## 2513 [/2513]

+ Model (application/json)

        {
            "code": 2513,
            "message": "Opened On date can not be in future."
        }

## 2514 [/2514]

+ Model (application/json)

        {
            "code": 2514,
            "message": "Opening Soon date is mandatory when business is marked as Opening soon."
        }


## 2515 [/2515]

+ Model (application/json)

        {
            "code": 2515,
            "message": "Reopen date is not supported for this date."
        }


## 2516 [/2516]

+ Model (application/json)

        {
            "code": 2516,
            "message": "Opening Soon Date can not be more than 1 year from now."
        }


## 2517 [/2517]

+ Model (application/json)

        {
            "code": 2517,
            "message": "Opening Soon date should not be less than current date."
        }


## 2518 [/2518]

+ Model (application/json)

        {
            "code": 2518,
            "message": "Business Status is mandatory to pass with reopen, opened on and opening soon date."
        }


## 2519 [/2519]

+ Model (application/json)

        {
            "code": 2519,
            "message": "Third party categories change for opening soon business is not allowed."
        }


## 2520 [/2520]

+ Model (application/json)

        {
            "code": 2520,
            "message": "Open Date is not supported for this date"
        }

## 2521 [/2521]

+ Model (application/json)

        {
            "code": 2285,
            "message": "Invalid text message number"
        }
## 2522 [/2522]

+ Model (application/json)

        {
            "code": 2286,
            "message": "Invalid whatsapp business link"
        }


## 5022 [/5022]

+ Model (application/json)

        {
            "code": 5022,
            "message": "Another custom field with same name already present."
        }

## 5023 [/5023]

+ Model (application/json)

        {
            "code": 5023,
            "message": "Custom field request dto cannot be null."
        }

## 5024 [/5024]

+ Model (application/json)

        {
            "code": 5024,
            "message": "Custom field creation failed."
        }

## 5025 [/5025]

+ Model (application/json)

        {
            "code": 5025,
            "message": "Custom field not found."
        }

## 5026 [/5026]

+ Model (application/json)

        {
            "code": 5026,
            "message": "Custom field updation failed."
        }

## 5028 [/5028]

+ Model (application/json)

        {
            "code": 5028,
            "message": "Custom field delete failed."
        }


## 5031 [/5031]

+ Model (application/json)

        {
            "code": 5031,
            "message": "Method not implemented for unknown custom field type."
        }

## 5039 [/5039]

+ Model (application/json)

        {
            "code": 5039,
            "message": "Custom field name cannot be a reserved keyword."
        }

## 5040 [/5040]

+ Model (application/json)

        {
            "code": 5040,
            "message": "Max limit reached for custom fields."
        }

## 1027 [/1027]

+ Model (application/json)

        {
            "code": 1027,
            "message": "Invalid business number."
        }


# Group Business
Create and maintain your business on Birdeye.

## Create Business [/v1/signup/reseller/subaccount{?rid,email_id}]
Create a business API creates a new business under a reseller.

### Create a business [POST]

+ Parameters

    + rid: 12334667201 (required, number) - Id of the Reseller.
    + email_id: sample@birdeye.com (required, string) - Business Email id.

+ Request (application/json)


    + Headers

            Accept: application/json
            x-api-key: [Required] Partner specific API key provided by Birdeye for data exchange.


    + Body

            {
                "businessName": "The Business Name",
                "zip": 32323,
                "type": "Business",
                "phone": "4032365164",
                "countryCode": "US"
                "aggrOptions" : 1
            }

    + Attributes

        + businessName: Test Business (required,string)- Name of the Business that needs to be added
        + zip: 32323 (required,string)- Postal code of the business location
        + type: Business (string)- Type of the Business. Valid values are
                Business,
                Enterprise-Location,
                Enterprise-Product,
                Reseller
                or a existing custom hierarchy type. Default is: Business.
        + phone: 4032365164 (required,number)- Phone number of the Business.
        + countryCode: AU (string) - This field is mandatory for non US locations.
        + aggrOptions:1 (number)- Aggregation Options to enable/disable aggregations. Possible values are [0,1]
                0 to Disable Search Business
                1 to Enable Search Business,

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


+ Response 200 (application/json)

    + Attributes

        + businessId:653356544 (number)- Id of the created business

    + Body

            {
               "businessId": 653356544
            }

+ Response 401

    [1161][]

+ Response 401

    [1167][]

+ Response 429

    [89][]

+ Response 401

    [1033][]

+ Response 404

    [1175][]

+ Response 404

    [1010][]

+ Response 400

    [1076][]

+ Response 400

    [1052][]

+ Response 400

    [1150][]

+ Response 400

    [1151][]

+ Response 400

    [1045][]

+ Response 400

    [1046][]

+ Response 400

    [1047][]

+ Response 400

    [1094][]

+ Response 400

    [1075][]

+ Response 400

    [1025][]

+ Response 400

    [1055][]
+ Response 400

    [1093][]

+ Response 400

    [2150][]

+ Response 400

    [2151][]

+ Response 400

    [2152][]

+ Response 400

    [2153][]

+ Response 400

    [2154][]

+ Response 400

    [2155][]

+ Response 400

    [2156][]

+ Response 400

    [2157][]

+ Response 400

    [2286][]

+ Response 400

    [2166][]


## Search [/v1/business/{businessNumber}/search]

Search Business API searches a business using a name or number. Partial name matching is also supported by API.


### Search Business [POST]

+ Parameters

    + businessNumber: 169744180007807 (required, number) - Long id of the business, under which user wants to search for.



+ Request (application/json)

    + Headers

            Accept: application/json
            x-api-key: [Required] Partner specific API key provided by Birdeye for data exchange.

    + Body

            {
                "pageSize": 25,
                "searchStr": "Thurston Rosenlund",
                "sortBy": "createdAt",
                "sortOrder": "ASC",
                "startIndex": 0
            }


    + Attributes

        + searchStr: Thurston Rosenlund (string)- Search criteria for business. This could be business name or number.
        + sortBy: createdAt (string)- Results can be sorted by name, createdAt, and createdBy. By default is createdAt.
            name : The business name

            createdAt: The date on which a business/location was created.

            createdBy: The full name of the user that created the business.
        + sortOrder: ASC (string)- The SORT order, Possible values "ASC" or "DESC". By default is "DESC".
        + startIndex: 0 (number)- Once sorted, it defines starting from which index a page (number of specified search results) is to be created.
        + pageSize: 25 (number)- Determines the number of search results in the response. Users can set a desired value to limit results, e.g., pageSize=25 shows the top 25 business listings. The Default value is 25.




+ Response 200 (application/json)

    + Attributes

        + totalCount: 101 (number) - The total number of search matches.
        + accounts (array) - Search results
            + (object)
                + name : Thurston Rosenlund (string) - The business name
                + status : active (string) - The business status - active, demo, paid, suspended etc.
                + createdAt: May 01, 2013 (string) - The date of business (or location) creation.
                + createdBy: Sam Bilings (string) - Full name of the user who created the business (or location).
                + businessNumber: 169744180007807 (string) - Unique number associated with every business (or location).
                + type: SMB (string)- Returned in case of resellers, specifies whether account is SMB, enterprise, or reseller




    + Body

            {
                "accounts": [
                {
                    "name": "Thurston Rosenlund",
                    "status": "suspended",
                    "createdAt": "May 01, 2013",
                    "createdBy": "Sam Bilings",
                    "businessNumber": 396982176121,
                    "type": "Business"
                },
                {
                    "name": "Aspen Springs Dental",
                    "status": "paid",
                    "createdAt": "May 20, 2013",
                    "businessNumber": 106026111239,
                    "type": "Business"
                },
                {
                    "name": "Cherry Creek Family Dental",
                    "status": "paid",
                    "createdAt": "May 20, 2013",
                    "businessNumber": 379451236128,
                    "type": "Business"
                }],
                "totalCount": 44
            }


+ Response 401

    [1161][]

+ Response 429

    [89][]

+ Response 400

    [400][]



## Get [/v1/business/{business_id}]
Get Business API gets business information, including product features opted and profile information.


### Get Business [GET]

+ Parameters
    + business_id: 12345678 (string, required) - Id of the Business.

+ Request (application/json)

    + Headers

            Accept: application/json
            x-api-key: [Required] Partner specific API key provided by Birdeye for data exchange.


+ Response 200 (application/json)

    + Attributes

        + businessId: 12345678 (number) - Id of the Business (Long).
        + name: Drs. Chalker and Peterson, A Dental Partnership (string) - Name of the Business/Product (Max 1000 character long).
        + alias: Drs. Chalker (string) - Alias, Your internal way of identifying this location.
        + emailId: Business (string) - Business Email ID.
        + phone (string) - Business Phone (Required) Format is (xxx) xxx-xxxx.
        + fax (string)- Fax number Format is (xxx) xxx-xxxx.
        + websiteUrl: www.dentistinatascadero.com (string)- Business website url.
        + description: *State of the Art Equipment *Serving North County Since 1976 *Gentle Care *Knowledgeable Staff (string)- Description of the business (10 to 4000 character long).
        + services: Other Dental Specialties, Orthodontists, Dentistry (required,string)- Services (Comma separated list of services offered; used for SEO).
        + keywords: Dentists Atascadero CA, Other Dental Specialties Atascadero CA, Orthodontists Atascadero CA (string)- Keywords (Comma separated list of keywords; Max 10 keywords; used for SEO).
        + logoUrl: http://bzimages-prod.s3.amazonaws.com/669029760/Logo 180 X 121.png (string) - Logo Image. Minimum 250 x 250px. Recommended: 720 X 720 px. 10 KB min.
        + coverImageUrl: https://d1py4eyp5hehj0.cloudfront.net/upload/1298481/1711607013627/defaultbusiness.png (string)- Cover Image (Dimension should be 1296 x 367 px).
        + gmbCover: http://d3cnqzq0ivprch.cloudfront.net/common/css/images/profile/abcd.jpg (string) - Google Cover Image Url.
        + facebookCover: http://d3cnqzq0ivprch.cloudfront.net/common/css/images/profile/fb.jpg (string) - Facebook Cover Image Url.
        + timezone: Pacific Standard Time (string)- Timezone of the business.
        + languages: English,Spanish (array)- Language.
        + isServiceAreaProvider: Yes (string) - To select whether the business is Service Area Business Type. Default value is : No. Possible values are:
                                    Yes
                                    No
        + serviceAreas (array) - Service Area information.
            + (object)
                + description: New York, NY, USA (string)  - Description about the Service Area.
                + placeId: ChIJ9YahAOasdwRSt7QSj (string)  - Place Id.
        + payment: Paypal, Visa, Master Card (string) - Payment Type (Max 250 character long).
        + hoursOfOperations (array) - Working hours of business for each day.
            + (object)
                + day: 5 (number) - 0(Monday), 1(Tuesday), 2(Wednesday) and so on.
                + workingHours (array) - Working hours of the business
                    + (object)
                        + startHour: 7:00 (string) - Start hour 9:00 (9 AM), 18:00 (6 PM)
                        + endHour: 17:30 (string) - End hour  9:00 (9 AM), 18:00 (6 PM)
                + isOpen: 1 (number) - 0 (Business closed today), 1 (open)
                + comment: By appointment only (string) - Add the special instruction.
        + working24x7: 0 (number) - Whether business is 24x7 open or not (0-false, 1-true).
        + location (object) - Business address
            + address1: 7405 Morro Rd (string) - Address of the business.
            + address2: Suite 102 (string) - Address of the business.
            + city: Atascadero (string) - City (Max 1000 character long).
            + state: CA (string) - State (2 character state code).
            + countryCode: US (string) - Country Code (2 character country code).
            + zip: 93422 (required,string) - Zip Code.
        + reviewCount: 105 (number)- Total review count of the business.
        + avgRating: 4.9 (number)- Average rating of the business.
        + status: demo (string) - Business status. Valid values are demo, active, inactive. Default is
        + type:Business (string)- Business type. Valid values are "Business, Enterprise-Location, Enterprise-Product, Reseller or a existing custom hierarchy type". Default is:
        + category: Dentist,Dental,Doctor (string) - Category (Mapped to Google Category).
        + socialProfileURLs (object) - Profile URLs for business on top rated social sites
            + facebookUrl: http://www.facebook.com/ChalkerandPetersonDental (string) - Facebook URL.
            + twitterUrl: https://twitter.com/DrsChaAndPet (string) - Business Twitter URL.
            + linkedInUrl: https://linkedin.com/DrsChaAndPet (string) - Business LinkedId URL.
            + googleUrl: https://plus.google.com/103957250846354895095/about?gl=US&hl=en-US (string)- Business Google URL.
            + youTubeUrl: https://www.youtube.com/channel/UCDNP0M75ySA5qt0So2F8Xxw (string)- Business Youtube URL.
        + isSEOEnabled: true (boolean) - Enable/Disbale search engine indexing of business profile. Valid values are "true","false". Default is "true"


    + Body

            {
                "businessId": 12345678,
              "name": "Dieci Lifestyle Spa",
              "alias": "Dieci Lifestyle Spa - Livingston, NJ",
              "emailId": "4568@livelovespa.com",
              "phone": "(973) 716-0101",
              "fax": "(973) 716-0102",
              "websiteURL": "http://www.diecispa.com/",
              "description": "Specialties\nBridal ServicesMakeup: Makeovers/Lessons/ Faux Lash applicationMassagesFacialsMicrocurrentMicrodermabrasionBody…",
              "keywords": "Hair Salons,Day Spas,Beauty Salon,Beauty Salons,Salons,Massage Therapists",
              "services": "Beauty Salon, Hair Spa",
              "logoURL": "http://d3cnqzq0ivprch.cloudfront.net/prod/css/images/logo.jpg",
              "coverImageURL": "http://d3cnqzq0ivprch.cloudfront.net/common/css/images/profile/spa.jpg",
              "gmbCover": "http://d3cnqzq0ivprch.cloudfront.net/common/css/images/profile/abcd.jpg",
              "facebookCover": "http://d3cnqzq0ivprch.cloudfront.net/common/css/images/profile/fb.jpg",
              "timezone": "Pacific Standard Time",
              "isServiceAreaProvider": "Yes",
                "serviceAreas": [
                {
                    "description": "2390 Boston Street, Seattle, WA, 98109",
                    "placeId": "ChIJ9YasdSKZs0wRSt--7QSjsd3"
                },
                {
                    "description": "400 Boston Street, Seattle, WA, 98109",
                    "placeId": "ChIJ9aasdAOKZasdaSt--7QsdLja4"
                }],
              "languages": [
                "English",
                "Spanish"
              ],
              "payment": "Visa, MasterCard, American Express, Debit Cards, Check",
              "hoursOfOperations": [
                {
                  "day": "0",
                  "isOpen": 1,
                  "workingHours": [
                    {
                      "startHour": "09:00",
                      "endHour": "13:30"
                    },
                    {
                      "startHour": "14:30",
                      "endHour": "19:00"
                    }
                  ],
                  "comment": ""
                },
                {
                  "day": "1",
                  "isOpen": 1,
                  "workingHours": [
                    {
                      "startHour": "09:00",
                      "endHour": "13:30"
                    },
                    {
                      "startHour": "14:30",
                      "endHour": "19:00"
                    }
                  ],
                  "comment": ""
                },
                {
                  "day": "2",
                  "isOpen": 1,
                  "workingHours": [
                    {
                      "startHour": "09:00",
                      "endHour": "13:30"
                    },
                    {
                      "startHour": "14:30",
                      "endHour": "19:00"
                    }
                  ],
                  "comment": ""
                },
                {
                  "day": "3",
                  "isOpen": 1,
                  "workingHours": [
                    {
                      "startHour": "09:00",
                      "endHour": "13:30"
                    },
                    {
                      "startHour": "14:30",
                      "endHour": "19:00"
                    }
                  ],
                  "comment": ""
                },
                {
                  "day": "4",
                  "isOpen": 1,
                  "workingHours": [
                    {
                      "startHour": "09:00",
                      "endHour": "13:30"
                    },
                    {
                      "startHour": "14:30",
                      "endHour": "19:00"
                    }
                  ],
                  "comment": ""
                },
                {
                  "day": "5",
                  "isOpen": 1,
                  "workingHours": [
                    {
                      "startHour": "09:00",
                      "endHour": "13:30"
                    },
                    {
                      "startHour": "14:30",
                      "endHour": "19:00"
                    }
                  ],
                  "comment": ""
                },
                {
                  "day": "6",
                  "isOpen": 0
                }
              ],
              "working24x7": 0,
              "location": {
                "address1": "90 W Mount Pleasant Ave",
                "address2": "(btwn Preston Dr. &amp; N. Mitchell Ave.)",
                "city": "Livingston",
                "state": "NJ",
                "zip": "07039",
                "countryCode": "US",
                "countryName": "United States of America"
              },
              "reviewCount": 53,
              "avgRating": 3.4,
              "status":"active",
              "type":"Business",
              "category": "Hair Salons,Day Spas,Beauty Salon,Beauty Salons,Salons,Massage Therapists",
              "socialProfileURLs": {
                "googleUrl": "null",
                "facebookUrl": null,
                "twitterUrl": null,
                "linkedinUrl": null,
                "youTubeUrl":null
              },
              "isSEOEnabled": "false",
              "baseUrl": "https://birdeye.com/diecispa-755009344"
            }

+ Response 401

    [1161][]

+ Response 429

    [89][]

+ Response 404

    [1011][]

+ Response 401

    [1167][]


## Update [/v1/business/{businessId}]
Update Business API updates business information.

### Update Business [PUT]

+ Parameters
    + businessId: 12345678 (string, required) - The Business Number

+ Request (application/json)

    + Headers

            Accept: application/json
            x-api-key: [Required] Partner specific API key provided by Birdeye for data exchange.

    + Attributes

        + name: Drs. Chalker and Peterson, A Dental Partnership (string) - Name of the Business/Product (Max 250 character long).
        + alias: Drs. Chalker (string) - Alias, Your internal way of identifying this location.
        + isAddressHidden: 0 (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
            + address1: 7405 Morro Rd (string) - Address of the business/location.
            + address2: Suite 102 (string) - Address of the business/location.
            + city: Atascadero (string) - City (Max 1000 character long).
            + state: CA (string) - State (2 character state code).
            + countryCode: US (string) - Country Code (2 character country code).
            + zip: 93422 (required,string) - Zip Code.
        + emailId: Business (required,string) - Business Email ID.
        + phone (required,string) - Business Phone (Required) Format is (xxx) xxx-xxxx.
        + fax (string)- Fax number Format is (xxx) xxx-xxxx.
        + websiteUrl: www.dentistinatascadero.com (string)- Business website url.
        + establishedYear: 2012 (number) - Year established
        + timezone: Pacific Standard Time (string)- Timezone of the business.
        + languages: English,Spanish (array)- Language.
        + isServiceAreaProvider: Yes (string) - To select whether the business is Service Area Business Type. Default value is : No.
                          Possible values are:
                                        Yes
                                        No
        + serviceAreas (array) - Service Area information. You can enter upto 10 service area addresses in one request
            + (object)
                + description: 400 Boston Street, Seattle, WA, 98109 (string)  - For supported service areas, Possible formats:
                                    1. Apartment Name/ Suite Name, Street Name/ Locality, City, State, ZIP
                                    2. Street Name/ Locality, City, State, ZIP

        + working24x7: 0 (number) - Whether business is 24x7 open or not (0-false, 1-true).
        + hoursOfOperations (array) - Working hours of business for each day.
            + (object)
                + day: 5 (number) - 0(Monday), 1(Tuesday), 2(Wednesday) and so on.
                + workingHours (array) - Working hours of the business
                    + (object)
                        + startHour: 7:00 (string) - Start hour 9:00 (9 AM), 18:00 (6 PM)
                        + endHour: 17:30 (string) - End hour  9:00 (9 AM), 18:00 (6 PM)
                + isOpen: 1 (number) - 0 (Business closed today), 1 (open)
                + comment: By appointment only (string) - Add the special instruction.
        + specialHours (array) - Special hours of business.
            + (object)
                + specialDate: 10/20/2023 (string) - It should be "MM/DD/YYYY".
                + startHour: 7:00 (string) - Start hour 9:00 (9 AM), 18:00 (6 PM)
                + endHour: 17:30 (string) - End hour  9:00 (9 AM), 18:00 (6 PM)
                + isOpen: 1 (number) - 0(Business closed today), 1 (open)
        + businessStatus : Open (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 : 10/20/2022 - 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.
        + services: Other Dental Specialties, Orthodontists, Dentistry (required,string)- Services (Comma separated list of services offered; used for SEO).
        + keywords: Dentists Atascadero CA, Other Dental Specialties Atascadero CA, Orthodontists Atascadero CA (string)- Keywords about the business. Useful in SEO. Business keyword cannot be more than 1000 characters.
        + products: Products about the business. Useful in SEO and Business products cannot be more than 1000 characters.
        + appointmentLink (string) - Let customers book appointments by redirecting them to your appointments page.
        + reservationLink (string) - Let customers reserve tables by linking them to your reservations page.
        + menuLink (string) - Show customers what you serve by linking them to your menu.
        + orderAheadLink (string) - 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: Paypal, Visa, Master Card (string) - Payment Type (Max 250 character long).
        + localPhoneNumber (string)- Local phone number.
        + tollFreePhoneNumber (string) - Tollfree number.
        + androidAppURL: http://www.gmail.com (string)- Android app url.
        + iosAppURL: http://www.gmail.com (string) - IOS app url.
        + logoUrl: http://bzimages-prod.s3.amazonaws.com/669029760/Logo 180 X 121.png (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: https://d1py4eyp5hehj0.cloudfront.net/upload/1298481/1711607013627/defaultbusiness.png (string) - Cover image URL for business displayed on custom review site. Format: JPG, JPEG, PNG. Minimum 1296 x 367px.
        + gmbCover: http://d3cnqzq0ivprch.cloudfront.net/common/css/images/profile/abcd.jpg (string) - Google Cover Image Url.
        + facebookCover: http://d3cnqzq0ivprch.cloudfront.net/common/css/images/profile/fb.jpg (string) - Facebook Cover Image Url.
        + coverBusinessInfoLayout: In grid cover image, business info overlay (string) - Show on your Birdeye profile. Possible value will be
                In grid cover image, business info overlay
                In grid cover image, business info below
                Full width cover image, business info overlay
                Full width cover image, business info below
                Google map view, business info overlay
        + covidInfo (object) - Provide covid related update in.
            + postDescription (string) - Post will be update on gmb & FB
            + covid19SupportLink (string) - Should be a valid covid19 support url
            + virtualCareLink (string) - Should be a valid url virtual care link
        + bingListing (object) - Provide bing data for listing purpose.
            + primaryCategoryBing (string) - Primary category of bing.
            + bingPhoneNumber (string) - You can provide a phone number which will be pushed only to your Bing listing site and will override the primary phone number set.
            + categories (string) - You can add up to 3 categories.
            + bingDescription (string) - Bing description cannot be more than 4096 characters.
        + internalListing (object) - Provide data for microsite listing purpose.
            + description (string) - Business description cannot be more than 5000 characters.
            + category (string) - Primary category of business.
            + subcategory (string) - You can add up to 3 subcategories.
            + displayCategory (string) - Choose one of the category either from primary category or from sub categories.
        + facebookListing (object) - Provide data for facebook listing purpose.
            + category (string) - You can add up to 3 categories.
            + facebookDescription (string) - Facebook description cannot be more than 255 characters.
            + facebookPhoneNumber (string) - Phone number for facebook profile. This phone number will override the main phone number on your Facebook business page

        + gmbListing (object) - Provide data for gmb listing purpose.
            + googleWebsiteUrl (string) - Website url will update on google listing.
            + googlePhoneNumber (string) - You can provide a phone number which will be pushed only to your google listing site and will override the primary phone number set.
            + googleStoreId (string) - Store id for google.
            + primaryCategoryGmb (string) - Primary category of google.
            + additionalCategory (string) - You can add up to 9 subcategories.
            + googleDescription (string) - Google description cannot be more than 750 characters.
            + attributes (object) - Google my business attributes are highly visible statements about your business that appear on your Google My Business listing. Supported attributes are
                    Accessibility,Amenities,Crowd,Dining options,Highlights,Planning,Offerings,Health & safety.
            + foodDelivery (string) - Enter the redirect URL where customers can place delivery orders.This field is applicable for hospitality business and is category dependent.Example http://www.ubereats.com
            + foodTakeout (string) - Enter the redirect URL where customers can place 'takeout' food orders. This field is applicable for hospitality business and is category dependent.Example : http://www.ubereats.com
        + socialProfileURLs (object) - Profile URLs for business on top rated social sites
            + facebookUrl: http://www.facebook.com/ChalkerandPetersonDental (string) - Facebook URL.
            + twitterUrl: https://twitter.com/DrsChaAndPet (string) - Business Twitter URL.
            + linkedInUrl: https://linkedin.com/DrsChaAndPet (string) - Business LinkedId URL.
            + googleUrl: https://plus.google.com/103957250846354895095/about?gl=US&hl=en-US (string)- Business Google URL.
            + youTubeUrl: https://www.youtube.com/channel/UCDNP0M75ySA5qt0So2F8Xxw (string)- Business Youtube URL.
        + isSEOEnabled: true (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
            + type: DROPDOWN_MULTI (string)- Type of field.
            + fieldValue: GR (string)- Custom field value.
            + fieldName: colours (required,string)-Name of custom field (Make sure to enter the same fieldName or else the new field will be created).
            + id: 376 (required,number)- fieldId of the custom field created earlier.

    + Body

            {
              "name": "Dieci Lifestyle Spa",
              "alias": "Dieci Lifestyle Spa - Livingston, NJ",
              "isAddressHidden": 0,
              "location": {
                "address1": "90 W Mount Pleasant Ave",
                "address2": "(btwn Preston Dr. &amp; N. Mitchell Ave.)",
                "city": "Livingston",
                "state": "NJ",
                "zip": "07039",
                "countryCode": "US",
                "countryName": "United States of America",
                "lat": "37.7730319",
                "lng": "-122.3869622"
              },
              "emailId": "4568@livelovespa.com",
              "phone": "(973) 716-0101",
              "fax": "(973) 716-0102",
              "websiteUrl": "http://www.diecispa.com/",
              "establishedYear": "2012",
              "timezone": "Pacific Standard Time",
              "languages": [
                "English",
                "Spanish"
              ],
                "isServiceAreaProvider": "Yes",
                "serviceAreas": [
                {
                    "description": "400 Boston Street, Seattle, WA, 98109"
                },
                {
                    "description": "2390 Boston Street, Seattle, WA, 98109"
                }],
              "working24x7": 0,
              "hoursOfOperations": [
                {
                  "day": "0",
                  "isOpen": 1,
                  "workingHours": [
                    {
                      "startHour": "09:00",
                      "endHour": "13:30"
                    },
                    {
                      "startHour": "14:30",
                      "endHour": "19:00"
                    }
                  ],
                  "comment": ""
                },
                {
                  "day": "1",
                  "isOpen": 1,
                  "workingHours": [
                    {
                      "startHour": "09:00",
                      "endHour": "13:30"
                    },
                    {
                      "startHour": "14:30",
                      "endHour": "19:00"
                    }
                  ],
                  "comment": ""
                },
                {
                  "day": "2",
                  "isOpen": 1,
                  "workingHours": [
                    {
                      "startHour": "09:00",
                      "endHour": "13:30"
                    },
                    {
                      "startHour": "14:30",
                      "endHour": "19:00"
                    }
                  ],
                  "comment": ""
                },
                {
                  "day": "3",
                  "isOpen": 1,
                  "workingHours": [
                    {
                      "startHour": "09:00",
                      "endHour": "13:30"
                    },
                    {
                      "startHour": "14:30",
                      "endHour": "19:00"
                    }
                  ],
                  "comment": ""
                },
                {
                  "day": "4",
                  "isOpen": 1,
                  "workingHours": [
                    {
                      "startHour": "09:00",
                      "endHour": "13:30"
                    },
                    {
                      "startHour": "14:30",
                      "endHour": "19:00"
                    }
                  ],
                  "comment": ""
                },
                {
                  "day": "5",
                  "isOpen": 1,
                  "workingHours": [
                    {
                      "startHour": "09:00",
                      "endHour": "13:30"
                    },
                    {
                      "startHour": "14:30",
                      "endHour": "19:00"
                    }
                  ],
                  "comment": ""
                },
                {
                  "day": "6",
                  "isOpen": 0
                }
              ],
              "specialHours": [
                {
                  "specialDate": "12/31/2020",
                  "startHour": "09:00",
                  "endHour": "12:00",
                  "isOpen": 0
                },
                {
                  "specialDate": "01/01/2021",
                  "startHour": "",
                  "endHour": "",
                  "isOpen": 1
                }
              ],
              "businessStatus": "Open",
              "reopenDate": "01/01/2021",
              "services": "Beauty Salon, Hair Spa",
              "keywords": "Hair Salons,Day Spas,Beauty Salon,Beauty Salons,Salons,Massage Therapists",
              "products": "Living Proof Dry Shampoo,Kevin Murphy Blonde Angel Wash",
              "appointmentLink": "",
              "reservationLink": "",
              "menuLink": "",
              "orderAheadLink": "",
              "payment": "Visa, MasterCard, American Express, Debit Cards, Check",
              "impressum": "",
              "localPhoneNumber": "",
              "tollFreePhoneNumber": "",
              "androidAppURL": "",
              "iosAppURL": "",
              "logoUrl": "https://d1py4eyp5hehj0.cloudfront.net/upload/1334812/1718082646457/2816b900140211eb870e7bf4ed6bc766.png",
              "gmbLogoOptOut": 1,
              "fbLogoOptOut": 1,
              "gmbCoverOptOut": 1,
              "fbCoverOptOut": 1,
              "coverImageUrl": "https://d1py4eyp5hehj0.cloudfront.net/upload/1334812/1718082720956/GustavKlimtExpectationTreeoflifeArboldelaVidaFulfilment.jpeg",
              "gmbCover": "https://d1py4eyp5hehj0.cloudfront.net/upload/1334812/1718082807649/41cdeb014d36cb35f936152d44c4c77d.jpeg",
              "facebookCover": "https://d1py4eyp5hehj0.cloudfront.net/upload/1334812/1718082871068/IJ8Sa5.jpeg",
              "coverBusinessInfoLayout": "In grid cover image, business info overlay",
              "covidInfo": {
                "postDescription": "",
                "covid19SupportLink": "",
                "virtualCareLink": ""
              },
              "bingListing": {
                "primaryCategoryBing": "",
                "category1Bing": "",
                "category2Bing": "",
                "category3Bing": "",
                "bingDescription": "",
                "bingPhoneNumber": ""
              },
              "internalListing": {
                "description": "pecialties\nBridal ServicesMakeup: Makeovers/Lessons/ Faux Lash applicationMassagesFacialsMicrocurrentMicrodermabrasionBody…",
                "category": "",
                "subcategory1": "",
                "subcategory2": "",
                "subcategory3": "",
                "displayCategory": ""

              },
              "facebookListing": {
                "category1Fb": "",
                "category2Fb": "",
                "category3Fb": "",
                "facebookDescription": "",
                "facebookPhoneNumber": ""
              },
              "gmbListing": {
                "googleWebsiteUrl": "",
                "googleStoreId": "",
                "primaryCategoryGmb": "",
                "additionalCategory1Gmb": "",
                "additionalCategory2Gmb": "",
                "additionalCategory3Gmb": "",
                "additionalCategory4Gmb": "",
                "additionalCategory5Gmb": "",
                "additionalCategory6Gmb": "",
                "additionalCategory7Gmb": "",
                "additionalCategory8Gmb": "",
                "additionalCategory9Gmb": "",
                "googleDescription": "",
                "googlePhoneNumber": ""
                "attributes": {
                  "Crowd": [
                    {
                      "attributeId": "welcomes_families",
                      "attributeName": "Family-friendly",
                      "value": true

                    }
                  ],
                  "Accessibility": [
                    {
                      "attributeId": "has_wheelchair_accessible_elevator",
                      "attributeName": "Wheelchair accessible elevator",
                      "value": false

                    }
                  ]
                },
                "foodDelivery":"https://www.ubereats.com",
                "foodTakeout":"https://www.ubereats.com"
              },
               "vendorListing": {
                "venderCategory": "",
                "venderSubcategory1": "",
                "venderSubcategory2": "",
                "venderSubcategory3": ""
             },
              "socialProfileURLs": {
                "googleUrl": "null",
                "facebookUrl": null,
                "twitterUrl": null,
                "linkedinUrl": null,
                "youTubeUrl": null,
                "instagramUrl": null,
                "pintrestUrl": null,
                "lendingtreeUrl": null,
                "bbbUrl": null
              },
              "isSEOEnabled": "false",
              "externalReferenceId" : "",
                "customFields": [
                 {
                 "fieldDescription": "This custom field contains list of colours.",
                 "fieldValue": "GR",
                 "fieldName": "colors",
                 "id": 376,
                 "defaultValue": "Green"
                }
              ]
            }

+ Response 200 (application/json)

    + Body

            {
              "name": "Dieci Lifestyle Spa",
              "alias": "Dieci Lifestyle Spa - Livingston, NJ",
              "emailId": "4568@livelovespa.com",
              "phone": "(973) 716-0101",
              "fax": "(973) 716-0102",
              "websiteUrl": "http://www.diecispa.com/",
              "description": "Specialties\nBridal ServicesMakeup: Makeovers/Lessons/ Faux Lash applicationMassagesFacialsMicrocurrentMicrodermabrasionBody…",
              "keywords": "Hair Salons,Day Spas,Beauty Salon,Beauty Salons,Salons,Massage Therapists",
              "services": "Beauty Salon, Hair Spa",
              "logoUrl": "http://d3cnqzq0ivprch.cloudfront.net/prod/css/images/logo.jpg",
              "coverImageUrl": "http://d3cnqzq0ivprch.cloudfront.net/common/css/images/profile/spa.jpg",
              "gmbCover": "http://d3cnqzq0ivprch.cloudfront.net/common/css/images/profile/abcd.jpg",
              "facebookCover": "http://d3cnqzq0ivprch.cloudfront.net/common/css/images/profile/fb.jpg",
              "timezone": "Pacific Standard Time",
              "languages": [
                "English",
                "Spanish"
              ],
              "isServiceAreaProvider": "Yes",
                "serviceAreas": [
                {
                    "description": "2390 Boston Street, Seattle, WA, 98109",
                    "placeId": "ChIJ9YasdSKZs0wRSt--7QSjsd3"
                },
                {
                    "description": "400 Boston Street, Seattle, WA, 98109",
                    "placeId": "ChIJ9aasdAOKZasdaSt--7QsdLja4"
                }],
              "payment": "Visa, MasterCard, American Express, Debit Cards, Check",
              "hoursOfOperations": [
                {
                  "day": "0",
                  "isOpen": 1,
                  "workingHours": [
                    {
                      "startHour": "09:00",
                      "endHour": "13:30"
                    },
                    {
                      "startHour": "14:30",
                      "endHour": "19:00"
                    }
                  ],
                  "comment": ""
                },
                {
                  "day": "1",
                  "isOpen": 1,
                  "workingHours": [
                    {
                      "startHour": "09:00",
                      "endHour": "13:30"
                    },
                    {
                      "startHour": "14:30",
                      "endHour": "19:00"
                    }
                  ],
                  "comment": ""
                },
                {
                  "day": "2",
                  "isOpen": 1,
                  "workingHours": [
                    {
                      "startHour": "09:00",
                      "endHour": "13:30"
                    },
                    {
                      "startHour": "14:30",
                      "endHour": "19:00"
                    }
                  ],
                  "comment": ""
                },
                {
                  "day": "3",
                  "isOpen": 1,
                  "workingHours": [
                    {
                      "startHour": "09:00",
                      "endHour": "13:30"
                    },
                    {
                      "startHour": "14:30",
                      "endHour": "19:00"
                    }
                  ],
                  "comment": ""
                },
                {
                  "day": "4",
                  "isOpen": 1,
                  "workingHours": [
                    {
                      "startHour": "09:00",
                      "endHour": "13:30"
                    },
                    {
                      "startHour": "14:30",
                      "endHour": "19:00"
                    }
                  ],
                  "comment": ""
                },
                {
                  "day": "5",
                  "isOpen": 1,
                  "workingHours": [
                    {
                      "startHour": "09:00",
                      "endHour": "13:30"
                    },
                    {
                      "startHour": "14:30",
                      "endHour": "19:00"
                    }
                  ],
                  "comment": ""
                },
                {
                  "day": "6",
                  "isOpen": 0
                }
              ],
              "working24x7": 0,
              "location": {
                "address1": "90 W Mount Pleasant Ave",
                "address2": "(btwn Preston Dr. &amp; N. Mitchell Ave.)",
                "city": "Livingston",
                "state": "NJ",
                "zip": "07039",
                "countryCode": "US",
                "countryName": "United States of America"
              },
              "categoryList": [
                "Hair Salons"
              ],
              "socialProfileURLs": {
                "googleUrl": "null",
                "facebookUrl": null,
                "twitterUrl": null,
                "linkedinUrl": null,
                "youTubeUrl": null
              }
            }

+ Response 401

    [1161][]

+ Response 429

    [89][]

+ Response 401

    [1167][]

+ Response 404

    [1175][]

+ Response 400

    [1045][]

+ Response 401

    [1047][]

+ Response 401

    [1046][]

+ Response 401

    [1055][]

+ Response 401

    [1056][]

+ Response 401

    [1069][]

+ Response 401

    [1070][]

+ Response 401

    [1190][]

+ Response 400

    [2296][]

+ Response 400

    [2297][]

+ Response 400

    [2290][]

+ Response 400

    [3334][]

+ Response 400

    [3335][]

+ Response 400

    [3336][]

+ Response 400

    [3337][]

+ Response 400

    [3348][]

+ Response 400

    [3348][]

+ Response 400

    [2511][]

+ Response 400

    [2512][]

+ Response 400

    [2513][]

+ Response 400

    [2514][]

+ Response 400

    [2515][]

+ Response 400

    [2516][]

+ Response 400

    [2517][]

+ Response 400

    [2518][]

+ Response 400

    [2519][]

+ Response 400

    [2520][]


## Delete [/v1/business/{business_Id}]
Delete Business API deletes an account or sub-reseller under a reseller.

### Delete Business [DELETE]


+ Parameters
    + business_Id: 12345678 (string, required) - Id of the Business.


+ Request (application/json)

    + Headers

            Accept: application/json
            x-api-key: [Required] Partner specific API key provided by Birdeye for data exchange.

+ Response 200 (application/json)

+ Response 400

    [1174][]

+ Response 401

    [1161][]

+ Response 429

    [89][]

+ Response 401

    [1167][]

+ Response 404

    [1175][]




## Status Update [/v1/business/{business_id}/status{?astatus}]
Status Update Business API updates the activation status of a business. Activation status signifies whether an account is active or inactive.

### Update the status [PUT]

+ Parameters

    + business_id: 12345678 (string, required) - Business id whose status has to be changed. Returned by create business API
    + astatus: inactive (string, required) - New status for the business. Valid values are "active/inactive".

+ Request (application/json)

    + Headers

            Accept: application/json
            x-api-key: [Required] Partner specific API key provided by Birdeye for data exchange.


+ Response 200 (application/json)

+ Response 401

    [1161][]

+ Response 429

    [89][]

+ Response 401

    [1167][]

+ Response 404

    [1175][]

+ Response 403

    [1184][]

+ Response 400

    [1191][]


## Child Businesses [/v1/business/child/all{?pid}]
Child Businesses API gets all the businesses under an account.

### Get Child Businesses [GET]


+ Parameters

    + pid:  12345678 (number, required) - Reseller/Sub-reseller/Enterprise Id.

+ Request (application/json)

    + Headers

            Accept: application/json
            x-api-key: [Required] Partner specific API key provided by Birdeye for data exchange.


+ Response 200 (application/json)

    + Attributes (array)
        + (object)
            + id: 123456 (number) - Id of the Business
            + name: Drs. Chalker and Peterson, A Dental Partnership (string) - Name of the Business/Product (Max 1000 character long).
            + alias: Drs. Chalker (string) - Alias, Your internal way of identifying this location.
            + phone (string) - Business Phone (Required) Format is (xxx) xxx-xxxx.
            + address (object) - Business address
                + address1: 7405 Morro Rd (string) - Address of the business.
                + address2: Suite 102 (string) - Address of the business.
                + city: Atascadero (string) - City (Max 1000 character long).
                + state: CA (string) - State (2 character state code).
                + countryCode: US (string) - Country Code (2 character country code).
                + zip: 93422 (required,string) - Zip Code.
            + status: demo (string) - Business status. Valid values are demo, active, inactive. Default is
            + type:Business (string)- Business type. Valid values are "Business, Enterprise-Location, Enterprise-Product, Reseller or a existing custom hierarchy type". Default is:
            + createdOn: Dec 05, 2013 (string) - Business singup date.
            + createdBy: Sam Bilings (string) - Full name of the user who created the business (or location).
            + childCount: 3 (number) - Child account count. note: applicable only for Reseller, Enterprise-Location, Enterprise-Product.


    + Body

            [{
                "id": 986031488,
                "name": "Central Ohio Endodontics",
                "alias": "Central Ohio Endodontics - Dublin, OH",
                "address": {
                    "address1": "5152 Blazer Memorial Pkwy",
                    "address2": "Ste 102",
                    "city": "Dublin",
                    "state": "OH",
                    "zip": "43017",
                    "countryCode": "US",
                    "countryName": "United States of America"
                },
                "phone": "(614) 896-2801",
                "type": "Business",
                "status": "active",
                "createdOn": "Dec 04, 2013",
                "createdBy": "Sam Bilings"
            },
            {
                "id": 768996864,
                "name": "Environmental Pest Management",
                "alias": "Environmental Pest Management - Westerville, OH",
                "address": {
                    "address1": "200 Hoff Rd",
                    "address2": "Unit P",
                    "city": "Westerville",
                    "state": "OH",
                    "zip": "43082",
                    "countryCode": "US",
                    "countryName": "United States of America"
                },
                "phone": "(614) 771-8605",
                "type": "Business",
                "status": "active",
                "createdOn": "Dec 05, 2013",
                "createdBy": "Sam Bilings"
            },
            {
                "id": 144670708364016,
                "name": "Sub-reseller",
                "alias": "Sub-reseller",
                "status": "active",
                "createdOn": "Nov 05, 2013",
                "type": "Reseller",
                "childCount": 1
            },
            {
                "id": 144670708364322,
                "name": "Holiday Inn",
                "alias": "Holiday Inn",
                "status": "active",
                "createdOn": "Nov 01, 2013",
                "type": "Enterprise-Location",
                "childCount": 2
            }]




## Public profile tabs [/v1/business/tabs{?businessId}]
Public profile tabs API saves information on business profile tabs.

### Update public profile of Businesses [POST]


+ Parameters
    + businessId: 12345678 (string, required) - Id of the Business.

+ Request (application/json)

    + Headers

            Accept: application/json
            x-api-key: [Required] Partner specific API key provided by Birdeye for data exchange.

    + Attributes (object)
        + profileTabs (array)
            + (object)
                + tabType: Map (string, required) - Valid values are "Reviews", "Feedback", "FAQ", "Aboutus", "Map", "Appointment" or "BusinessOwner".
                + label: map location (string) - Name on the tab. Max length 30 character.
                + showOnProfile: 1 (number, required) - Show on profile Valid values "0" or "1".
                + showOnWebsite: 0 (number, required) - Show on website Valid values "0" or "1".
                + showOnFacebook: 1 (number, required) - Show on Facebook Valid values "0" or "1".
                + url (string) - Valid url for tab.

    + Body

            {
                "profileTabs":
                [{
                    "tabType": "map",
                    "label": "map location",
                    "showOnProfile": 0,
                    "showOnWebsite": 1,
                    "showOnFacebook": 1,
                    "url": "http://www.mapurl.com"
                },
                {
                    "tabType": "Feedback",
                    "label": "Feedback",
                    "showOnProfile": 0,
                    "showOnWebsite": 1,
                    "showOnFacebook": 1,
                    "url": "http://www.feedback.com"
                }]
            }



+ Response 200 (application/json)


+ Response 401

    [1161][]

+ Response 429

    [89][]

+ Response 401

    [1167][]

+ Response 404

    [1175][]

+ Response 403

    [1184][]

+ Response 400

    [1191][]


## Get Hierarchy [/v1/business/{businessId}/hierarchy]
Get Hierarchy API gets business hierarchy. Hierarchical information contains the parent-child relationship information
between businesses.

### Get hierarchy for an enterprise [GET]

+ Parameters

    + businessId: 12345678 (string, required) - Id of the Business.


+ Request (application/json)

    + Headers

            Accept: application/json
            x-api-key: [Required] Partner specific API key provided by Birdeye for data exchange.

+ Response 200 (application/json)

            {
                "id": 143424324234234,
                "name": "Psychiatry",
                "alias": null,
                "address": null,
                "phone": null,
                "status": "active",
                "createdOn": "Sep 03, 2016",
                "type": "Department",
                "websiteUrl": null,
                "child": [{
                    "id": 147293020095434,
                    "name": "Addiction Psychiatry",
                    "alias": null,
                    "address": null,
                    "phone": null,
                    "status": "active",
                    "createdOn": "Sep 03, 2016",
                    "type": "Specialty",
                    "websiteUrl": null,
                    "child": [{
                        "id": 147293022348715,
                        "name": "NYC Center for Treatment and Research",
                        "alias": null,
                        "address": null,
                        "phone": null,
                        "status": "active",
                        "createdOn": "Sep 03, 2016",
                        "type": "Practice",
                        "websiteUrl": null,
                        "child": [{
                            "id": 1467324432430144,
                            "name": "Anna B. B., M.D",
                            "alias": "Anna B. B., M.D",
                            "address": {
                                "address1": "NYC Center for Treatment and Research",
                                "address2": "561 West 35th Street, 11th Floor",
                                "city": "New York",
                                "state": "NY",
                                "zip": "10036",
                                "countryCode": "US",
                                "countryName": "United States of America"
                            },
                            "phone": "646-xxx-xxxx ",
                            "status": "active",
                            "createdOn": "Jun 30, 2016",
                            "type": "Physician",
                            "websiteUrl": "https://google.org/abbnyc",
                            "child": []
                        }]
                    }]
                }],
                "parents": [{
                    "id": 148189355091299,
                    "name": "Neurology",
                    "alias": null,
                    "address": null,
                    "phone": null,
                    "status": "active",
                    "createdOn": "Dec 16, 2016",
                    "type": "Specialty",
                    "websiteUrl": null,
                    "tags": null,
                    "child": [],
                    "parents": []
                }]
            }


+ Response 401

    [1161][]

+ Response 429

    [89][]

+ Response 401

    [1167][]


## Update Hierarchy [/v1/business/business-hierarchy/location/update-mapping/{businessId}]
The Update Hierarchy API maps the hierarchical level to its corresponding level value for a given location. This API is used to update the hierarchical structure of locations, ensuring that each location is correctly placed within the hierarchy based on its level and value. It is important to avoid overwriting existing data by passing all values accurately.


### Update Hierarchy [POST]

+ Parameters

    + businessId: 12345678 (string, required) - Id of the Business.

+ Request (application/json)


    + Headers

            Accept: application/json
            x-api-key: [Required] Partner specific API key provided by Birdeye for data exchange.

   + Attributes
        + Level - It will be a key-value pair for each level with its corresponding level value.


    + Body

            {
              "Division": "Division 3",
              "Region": "Region 3",
              "RD": "Richard Steves",
              "Department": "Store 3"
            }



+ Response 200 (application/json)

+ Response 401

    [1161][]

+ Response 429

    [89][]

+ Response 401

    [1167][]


+ Response 401

    [1011][]



## Get Custom card details [/v1/business/{businessNumber}/profile/customcard]
Get Customer card API returns the detail of customer card of the location

### Get Custom card details [GET]

+ Parameters
    + businessNumber (number, required) - Id of a business (Long).

+ Request (application/json)

    + Headers

            Accept: application/json
            x-api-key: [Required] Partner specific API key provided by Birdeye for data exchange.



+ Response 200 (application/json)


    + Attributes
        + customCardDetails (array)
            + (object)
                + cardId: 123456 (number) - Id of the Card
                + title: Steve Smith (string) - Name of the card.
                + description: Business Information (string) - Information of the business on the card.
                + imageURL: https://d2xt3xymj142xp.cloudfront.net/63936/fileUpload/936_16768607_FRetIc.jpeg (string) - Image URL
                + imagePosition: 2 (string) - Image position value. Possible values are:
                        1 - image is placed at top,
                        2 - image is placed at left,
                        3 - image is placed at right
                + isVisible: 1 (number) - Visibility status of card on the microsite. Possible values are:
                        0 - card will not be visible on the microsite,
                        1 - card will be visible on the microsite
                + clickURL: https://www.abcdef.com (string) - Redirect link for a particular website.
                + linkText: Learn More (string) - Enter the text you want displayed for the link.

    + Body

            {
                "customCardDetails": [
                    {
                        "cardId": 5531,
                        "title": "Mathew",
                        "description": "Card description",
                        "imageURL": "https://d2xt3xymj142xp.cloudfront.net/63936/fileUpload/936_16768607_FRetIc.jpeg",
                        "imagePosition": "2",
                        "isVisible": 1,
                        "clickURL": "https://www.abcdef.com",
                        "linkText": "Learn More"
                    },
                    {
                        "cardId": 5533,
                        "title": "Steve Smith",
                        "description": "Card description",
                        "imageURL": "https://d2xt3xymj142xp.cloudfront.net/63936/fileUpload/63676550205863_FRetIc.jpeg",
                        "imagePosition": "1",
                        "isVisible": 0,
                        "clickURL": "http://www.abcdef.com",
                        "linkText": "Schedule"
                    }
                ]
            }


+ Response 401

    [1161][]

+ Response 429

    [89][]

+ Response 401

    [1167][]

+ Response 401

    [1011][]


## Get Timezone List [/v1/business/{businessNumber}/timezones]
Get Timezone List API fetches the list of all available timezones.

### Get Timezone List [GET]

+ Parameters
    + businessNumber (number, required) - Id of a business (Long).

+ Request (application/json)

    + Headers

            Accept: application/json
            x-api-key: [Required] Partner specific API key provided by Birdeye for data exchange.



+ Response 200 (application/json)


    + Attributes
        + timezones (array)
            + (object)
                + value: 123456 (number) - The timezone value.
                + label: Steve Smith (string) - The timezone label.


    + Body

            {
                "timezones": [
                    {
                        "value": "Etc/GMT+12",
                        "label": "(GMT-12:00) Etc/GMT+12"
                    },
                    {
                        "value": "Pacific/Pago_Pago",
                        "label": "(GMT-11:00) Pacific/Pago_Pago"
                    },
                    {
                        "value": "Pacific/Samoa",
                        "label": "(GMT-11:00) Pacific/Samoa"
                    },
                    {
                        "value": "Pacific/Niue",
                        "label": "(GMT-11:00) Pacific/Niue"
                    }
             ]
            }



+ Response 401

    [1161][]

+ Response 429

    [89][]

+ Response 401

    [1011][]

## Get Birdeye Impressions [/v1/business/{businessNumber}/birdeye/impressions]
Returns only birdeye (source: website) impressions by location as well as total.

### Get Birdeye Impressions [POST]

+ Parameters

    + businessNumber: 169744180007807 (string, required) - Account Business Number.


+ Request (application/json)

    + Headers

            Accept: application/json
            x-api-key: - Partner specific API key provided by Birdeye for data exchange.

    + Attributes
         + businessNumbers: 169744180007807 (required,string)- list of the unique business ids associated with a business eg: [123456789, 987656789]
         + startDate: 2020-11-10 (required,string)-yyyy-MM-dd eg: "2020-11-10"
         + endDate: 2020-11-10 (required,string)-yyyy-MM-dd eg: "2020-11-10"
         + limit: 25 (number) - page size. default: 25
         + startIndex: 0 (number)- default: 0
         + sortby: 25 (string) - "location" or "total" default: total.
         + order: asc (string) - "asc" or "desc" default: desc

    + Body

            {
                "businessNumbers": [147286063579104,147286063579108],
                "startDate": "2022-11-23",
                "endDate": "2023-11-23",
                "limit": 5,
                "order": "desc",
                "sortby": "location",
                "startIndex": 0
            }



+ Response 200


    + Body

            {
                  "total": 300178,
                  "locations": [
                    {
                      "locationName": "Natick House of Prom",
                      "count": "87"
                    },
                    {
                      "locationName": "Kansas City House of Prom",
                      "count": "265"
                    },
                    {
                      "locationName": "Glendale House of Prom House of Prom",
                      "count": "158"
                    },
                    {
                      "locationName": "Fairfax House of Prom",
                      "count": "355"
                    },
                    {
                      "locationName": "David's Bridal - Corporate Office",
                      "count": "2546"
                    }
                  ]
            }

+ Response 401

    [1161][]

+ Response 2292

    [2292][]

+ Response 2293

    [2293][]

+ Response 401

    [1167][]

# Group Custom Fields
Create, delete , update , associate and get custom fields easily.

## Create Custom Fields [/v1/business/public/custom-fields/create]
Create custom Fields
### Create [POST]


+ Request (application/json)

    + Headers

            Accept: application/json
            x-api-key: - Partner specific API key provided by Birdeye for data exchange.
            x-business-number: - Long Business Number

    + Attributes
         + defaultValue: Green (string)- Default Value of custom field.
         + dropDownOptions: Blue,Green,Red (array)- The list of options in custom field.
Only required when when type is either "DROPDOWN_SINGLE" or "DROPDOWN_MULTI".
         + fieldDescription: This custom field contains list of colours (string)-Description of custom field.
         + fieldName: colours (required,string)-Name of custom field.
         + filterable: false (boolean)- Whether the custom field will be filterable or not. Default: false
         + type: DROPDOWN_MULTI (required,string)- Type of custom field.
         Values allowed are TEXT, URL, NUMBER, DATE, DROPDOWN_SINGLE ,DROPDOWN_MULTI,TEXT_RAW.

    + Body

            {
               "defaultValue": "Green",
               "dropDownOptions": ["Blue", "Green", "Red"],
               "fieldDescription": "This custom field contains list of colours",
               "fieldName": "colours",
               "filterable": "false",
               "type": "DROPDOWN_MULTI"
            }



+ Response 200


    + Body

            {

                    "id": 376,
                    "fieldName": "colours",
                    "created": 1751480725861,
                    "updated": 1751480725861

            }

+ Response 400

    [5022][]

+ Response 400

    [5023][]

+ Response 400

    [5024][]

+ Response 400

    [5031][]

+ Response 400

    [5039][]

+ Response 400

    [5040][]


## Update Custom Fields [/v1/business/public/custom-fields/update/{fieldId}]
Update custom Fields
### Update [PUT]

+ Parameters
    + fieldId: 376 (required,number)- fieldId of the custom field created earlier.


+ Request (application/json)

    + Headers

            Accept: application/json
            x-api-key: - Partner specific API key provided by Birdeye for data exchange.
            x-business-number: - Long Business Number



    + Attributes
         + defaultValue: Green (string)- Default Value of custom field.
         + dropDownOptions: Blue,Green,Red (array)- The list of options in custom field.The list of options in custom field
           (In case the dropdown options were added during creation, while updating , add the same in
         + fieldDescription: This custom field contains list of colours (string)-Description of custom field.
         + filterable:  false (boolean)- Whether the custom field will be filterable or not.
         + isHidden: false (boolean)- Whether the custom field will be hidden or not.

    + Body

            {
                "defaultValue": "Green",
                "dropDownOptions": ["Blue", "Green", "Red"],
                "fieldDescription": "This custom field contains list of colours",
                "filterable": "false",
                "isHidden": "false"
            }




+ Response 200


    + Body

            {
                    OK
            }

+ Response 400

     [5025][]


+ Response 400

    [5026][]


## Get Custom Fields [/v1/business/public/custom-fields/get/{fieldId}?locationBizNumber={locationBizNumber}]
Get custom Fields
### Get [GET]

+ Parameters
    + fieldId: 376 (required,number)- fieldId of the custom field created earlier.
    + locationBizNumber : 123456789 (number)- Long Location number of the Location

+ Request (application/json)

    + Headers

            Accept: application/json
            x-api-key: - Partner specific API key provided by Birdeye for data exchange.
            x-business-number: - Long Business Number



+ Response 200

    + Attributes
         + id: 376 (number)- fieldId of the custom field.
         + fieldValue: Green (string)- Field Value of custom field and will only be visible if value is present.
         + fieldName: colours (string)- Name of the custom field.
         + type: DROPDOWN_MULTI (string)- Type of field.
         + defaultValue: Green (string)- Default Value of custom field and will only be visible if value is present.
         + fieldDescription: This custom field contains list of colours (string)-Description of custom field.
         + filterable:  false (boolean)- Whether the custom field will be filterable or not.

    + Body

            {
               "id": 376,
               "fieldName": "colours",
               "fieldValue": "Green",
               "type": "DROPDOWN_MULTI",
               "defaultValue": "Greens",
               "fieldDescription": "This custom field contains list of colours",
               "filterable": false
            }


+ Response 400

     [5025][]


## Get Custom Fields List [/v1/business/public/custom-fields/getList?locationBizNumber={locationBizNumber}]
Get custom Fields List
### POST [POST]

 + Parameters
    + locationBizNumber : 123456789 (number) - Long Location number of the Location.


+ Request (application/json)



    + Headers

            Accept: application/json
            x-api-key: - Partner specific API key provided by Birdeye for data exchange.
            X-BUSINESS-NUMBER: - Long Business Number

    + Attributes

         + page: 0 (required,number)- Page number depending upon the size entered.
         + size: 50 (required,number)- Maximum number of custom fields required in a result.
         + searchStr: colours (string)- To Search for a particular field via custom field Name .
         + sortBy:  fieldDescription (string)- To sort the resultsFor eg via fieldName,id, etc.
         + orderBy: asc (string)- Order of the list and it can be only asc or desc.

    + Body

            {
                "page":0,
                "size": 50,
                "searchStr": "colours",
                "sortBy": "fieldDescription",
                "orderBy": "asc"
            }



+ Response 200

    + Attributes
         + id: 376 (number)- fieldId of the custom field.
         + fieldValue: Green (string)- Field Value of custom field and will only be visible if value is present.
         + fieldName: colours (string)- Name of the custom field.
         + type: DROPDOWN_MULTI (string)- Type of field.
         + defaultValue: Green (string)- Default Value of custom field and will only be visible if value is present.
         + fieldDescription: This custom field contains list of colours (string)-Description of custom field.
         + filterable:  false (boolean)- Whether the custom field will be filterable or not.
         + dropDownOptions: Blue,Green,Red (array)- The list of options in custom field and will only be visible if value is present.

    + Body

            {
               "id": 376,
               "fieldName": "colours",
               "fieldValue": "Green",
               "type": "DROPDOWN_MULTI",
               "defaultValue": "Greens",
               "fieldDescription": "This custom field contains list of colours",
               "filterable": false,
               "dropDownOptions": [
                  {
                    "value": "Blue"
                   },
                  {
                    "value": "Green"
                  },
                  {
                   "value": "Red"
                  }
                ]
            }


+ Response 406

     [1027][]


## Delete Custom Fields [/v1/business/public/custom-fields/delete/{fieldId}]
Delete custom Fields
### Delete [DELETE]

+ Parameters
    + fieldId: 376 (required,number)- fieldId of the custom field created earlier.


+ Request (application/json)

    + Headers

            Accept: application/json
            x-api-key: - Partner specific API key provided by Birdeye for data exchange.
            x-business-number: - Long Business Number



+ Response 200

   + Body

            {
                    OK
            }


+ Response 400

     [5025][]

+ Response 400

     [5028][]


## Associate Custom Fields [/v1/business/public/custom-fields/associate]
Associate custom Fields
### Associate [PUT]


+ Request (application/json)

    + Headers

            Accept: application/json
            x-api-key: - Partner specific API key provided by Birdeye for data exchange.
            x-business-number: - Long Business Number.


    + Attributes
         + fieldId: 376 (required,number)- fieldId of the custom field.
         + fieldValue: Green (required,string)- Field Value of custom field and will only be visible if value is present.
         + businessNumber: 1234567890 (required,number)- Long Business Number.

    + Body

            {
                "businessNumber": 1234567890,
                "fieldId": 376,
                "fieldValue": "Green"
            }

+ Response 200

    + Attributes
         + id: 376 (number)- fieldId of the custom field.
         + fieldName: colours (string)- Name of the custom field.
         + type: DROPDOWN_MULTI (string)- Type of field.
         + fieldValue: Green (string)- Associated Field Value of custom field .
         + defaultValue: Green (string)- Default Value of custom field and will only be visible if value is present.
         + isHidden: false (boolean)- Whether the custom field will be hidden or not.
         + allBusinesses: false (boolean)- Whether the custom field will be for all businesses or not.
         + filterable: false (boolean)- Whether the custom field will be filterable or not.

   + Body

            {
                "id": 376,
                "fieldName": "colours",
                "type": "DROPDOWN_MULTI",
                "fieldValue": "Green",
                "isHidden": false,
                "allBusinesses": false,
                "filterable": false
            }


+ Response 400

     [5025][]

+ Response 400

     [5028][]


## Create Custom card [/v1/business/public/card]
Create Custom card API creates a custom card for a business profile.

### Create Custom card [POST]

+ Request (application/json)

    + Headers

            Accept: application/json
            x-api-key: [Required] Partner specific API key provided by Birdeye for data exchange.
            x-business-number: [Required] Long Business Number.

    + Attributes
        + title: AKJ test (required, string) - Title shown on the custom card.
        + description: custom card test (string) - Description/content shown on the custom card.
        + imageURL: https://d1py4eyp5hjjj0.cloudfront.net/upload/1670003/1759138378356/image12.png (string) - Public image URL displayed on the card.
        + imagePosition: 1 (number) - Position of the image on the card.
        + isVisible: 0 (number) - Visibility status of card on the microsite.
        + isPinOnTop: 1 (number) - Pin status of card on the microsite.
        + clickURL: https://www.example.com (string) - Redirect URL for card click action.

    + Body

            {
                "clickURL": "",
                "description": "custom card test",
                "imagePosition": 1,
                "imageURL": "https://d1py4eyp5hehj0.cloudfront.net/upload/1670003/1759138378356/image12.png",
                "isPinOnTop": 1,
                "isVisible": 0,
                "title": "AKJ test"
            }

+ Response 200 (application/json)

    + Attributes
        + cardId: 92426 (number) - Id of the created custom card.
        + title: AKJ test (string) - Title shown on the custom card.
        + description: custom card test (string) - Description/content shown on the custom card.
        + imageURL: https://d1py4eyp5hehj0.cloudfront.net/upload/1670003/1759138378356/image12.png (string) - Public image URL displayed on the card.
        + imagePosition: 1 (string) - Image position value.
        + isVisible: 0 (number) - Visibility status of card on the microsite.
        + isPinOnTop: 1 (number) - Pin status of card on the microsite.
        + clickURL: "" (string) - Redirect URL for card click action. Empty when no redirect is configured.

    + Body

            {
                "cardId": 92426,
                "title": "AKJ test",
                "description": "custom card test",
                "imageURL": "https://d1py4eyp5hehj0.cloudfront.net/upload/1670003/1759138378356/image12.png",
                "imagePosition": "1",
                "isVisible": 0,
                "isPinOnTop": 1,
                "clickURL": ""
            }


+ Response 401

    [1161][]

+ Response 429

    [89][]

+ Response 401

    [1167][]

+ Response 401

    [1011][]


# Group User
Delete and manage user profiles and permissions easily.

## Signup [/v1/user/signup/v2]
Create User API creates a new user for a business.
By default, an invitation is sent to the user via email.

### Create User [POST]

+ Request (application/json)

    + Headers

            Accept: application/json
            x-api-key: [Required] Partner specific API key provided by Birdeye for data exchange.
            x-business-number: [Required] User associated businessNumber


    + Attributes (object)

        + firstName: Rhonda (string) - First name of the user.
        + lastName: Spears (string) - Last name of the user.
        + userEmailId: rhonda@test.com (string, required) - Email Id of the user that’s being added to this business.
        + phone: 123-456-7890 (string) - Mobile number of the user.
        + userRole: admin (string, required) - User role. Valid values are "owner","admin". Default is "owner".
        + sendInvite: true (boolean) - Whether to send invite email to the user. Default is `true`.

    + Body

            {
                "firstName": "Rhonda",
                "lastName": "Spears",
                "userEmailId": "rhonda.spears@example.com",
                "phone": "408-xxx-xxxx",
                "userRole": "owner",
                "sendInvite": true
            }

+ Response 200 (application/json)

+ Response 401

    [1161][]

+ Response 429

    [89][]

+ Response 401

    [1167][]

+ Response 401

    [1033][]

+ Response 409

    [1160][]

+ Response 404

    [1175][]

+ Response 400

    [1052][]

+ Response 400

    [1053][]

+ Response 400

    [1054][]

+ Response 400

    [1014][]

+ Response 400

    [1013][]

+ Response 400

    [1057][]

+ Response 400

    [1059][]


## Update User [/v1/user/updateUser{?userEmailId,entUser}]
Updates an existing user’s access, notifications, and role.


### Update User [PUT]

+ Parameters
    + userEmailId: abc@test.com (string, required) - Email id of the user to be updated
    + entUser : false (boolean) - true if the user needs to provide enterprise level access in case of all locations.
                entUser needs to be passed as true if user needs to be provided access to all locations otherwise by default its false.


+ Request (application/json)

    + Headers

            Accept: application/json
            x-api-key: [Required] Partner specific API key provided by Birdeye for data exchange.
            x-business-number: [Required] User assosiated businessNumber

    + Attributes (object)

        + locationsNumberAccess: 3901784402334,3901744402337 (array) - Location Numbers list of which the user has access. Must provide full list each time, empty list grants access to all locations.
        + user - user details
               + firstName: Rhonda (string) - First name of the user.
               + lastName: Randy (string) - The last name of the user.
        + userRole: admin (string) - Role to assign within the application.
        + notification - user details
               + sendReviewEmailAlert: 1 (number) - Flag to enable sending of review email alerts.
               + sendDailyReviewDigest: 0 (number) - Flag to enable sending of daily review summary emails.
               + dailyDigestAbsoluteTime: 5:00 (string) - Daily digest delivery time in HH:MM format.
               + dailyDigestRunHour: 5 (number) - Hour component when daily digest is executed.
               + dailyDigestRunMinute: 0 (number) - Minute component when daily digest is executed.
               + sendWeeklyReviewDigest: 0 (number) - Flag to enable sending of weekly review summary emails.
               + weeklyDigestAbsoluteTime: 05:30 (string) - Weekly digest delivery time in HH:MM format.
               + weeklyDigestRunDay:  0 (number) - Day of the week for executing the weekly digest (0=Sunday).
               + weeklyDigestRunHour: 5 (number) - Hour component when weekly digest is executed.
               + weeklyDigestRunMinute: 0 (number) - Minute component when weekly digest is executed.
               + sendReviewSmsAlert: 1 (number) - Flag to enable sending of review SMS alerts.
               + sendDailySocialDigest: 1 (number) - Flag to enable sending of daily social media digests.
               + sendTicketAlert: 1 (number) - Flag to enable sending of alerts when a new ticket is created.
               + sendTicketStatusAlert: 0 (number) - Flag to enable sending of alerts when a ticket status changes.
               + sendTicketAssigneeChangeAlert: 1 (number) - Flag to enable sending of alerts when ticket assignee changes.
               + sendTicketCommentAlert: 0 (number) - Flag to enable sending of alerts when comments are added to tickets.
               + sendTicketStartOrStoppedWatchingAlert: 0 (number) - Flag to enable sending of alerts when watching status changes for tickets.
               + sendSurveyAlert: 1 (number) - Flag to enable sending of survey invitation alerts.
               + sendReferralAlert: 1 (number) - Flag to enable sending of referral alerts.
               + sendScanToolSignUpAlert: 1 (number) - Flag to enable sending of scan tool signup alerts.
               + webChatEmailInterval: 15,M (string) - Interval for web chat email notifications (e.g., "15,M").
               + webChatEmailAbsoluteTime: 05:30 (string) - Absolute time for web chat email notifications in HH:MM format.
               + enableWebchat: 1 (number) - Flag to enable web chat notifications.
               + enableTeamAlert: 0 (number) - Flag to enable team-wide alerts.
               + reviewAlertRatings: 1,2,3,4,5,0,-1 (array) - Array of review ratings that trigger alerts.
               + messengerEmailConversationType: unAssigned,assignedToMe,assignedToOthers (string) - Comma-separated conversation types for messenger email notifications.
               + assignedToMeAlert: 1 (number) - Flag to enable alerts for items assigned to the current user.
               + enableBrowserNotification: 1 (number) - Flag to enable browser push notifications.
               + messengerReportEnable: 1 (number) - Flag to enable messenger report feature.
               + appointmentBooking: 1 (number) - Flag to enable in-app appointment booking feature.
               + appointmentFormsEnabled: 1 (number) - Flag to enable appointment forms.
               + enableAIPostSuggestions: 0 (number) - Flag to enable AI-driven post suggestions.
               + enablePostFailureEmail: 1 (number) - Flag to enable email alerts for post failures.
               + enableDirectMessageEmail: 1 (number) - Flag to enable email alerts for direct messages.
               + enablePostCommentsEmail: 1 (number) - Flag to enable email alerts for post comments.
               + enableMentionsEmail: 1 (number) - Flag to enable email alerts when the user is mentioned.
               + enableStoryMentionsEmail: 0 (number) - Flag to enable email alerts for story mentions.
               + enableNewFollowersEmail: 0 (number) - Flag to enable email alerts for new followers.
               + enableRetweetEmail: 0 (number) - Flag to enable email alerts when a post is retweeted.
               + enableQuoteTweetEmail: 0 (number) - Flag to enable email alerts for quote tweets.
               + enablePostFailureBrowserNotification: 1 (number) - Flag to enable browser notifications for post failures.
               + paymentAlert: 1 (number) - Flag to enable payment-related alerts.
               + sendBrokenIntegrationAlert: 1 (number) - Flag to enable in-app alerts for broken integrations.
               + sendBrokenIntegrationEmail: 1 (number) - Flag to enable email alerts for broken integrations.

    + Body

            {
              "locationsNumberAccess": [0],
              user:{
              "firstName": "string",
              "lastName": "string",
              },
              "userRole": "string",
              "notification": { /* as above */ }
            }


+ Response 200 (application/json)

+ Response 400

    [1010][]

+ Response 401

    [1161][]

+ Response 429

    [89][]

+ Response 401

    [1167][]

+ Response 401

    [1177][]

+ Response 404

    [1189][]



## Delete [/v1/user/remove{?bid,email}]
Delete User API removes user access from a business.

### Delete a user [DELETE]

+ Parameters
    + bid: 123 (string, required) - Business Id from which user access has to be revoked
    + email: abc@test.com (string, required) - Email id of the user whose access has to be revoked


+ Request (application/json)

    + Headers

            Accept: application/json
            x-api-key: [Required] Partner specific API key provided by Birdeye for data exchange.

+ Response 200 (application/json)

+ Response 400

    [1059][]

+ Response 401

    [1161][]

+ Response 429

    [89][]

+ Response 401

    [1167][]

+ Response 404

    [1188][]

+ Response 404

    [1189][]

+ Response 404

    [1175][]


## Password [/v1/user/forgotpassword{?email}]
Forgot Password API generates forgot password mail to reset the password.

### Forgot Password [POST]

+ Parameters

    + email: abc@test.com  (string, required) - Email Id of the user whose access has to be revoked

+ Request (application/json)

    + Headers

            Accept: application/json
            x-api-key: [Required] Partner specific API key provided by Birdeye for data exchange.

+ Response 200 (application/json)

+ Response 400

    [1052][]

+ Response 401

    [1161][]

+ Response 429

    [89][]

+ Response 401

    [1167][]

+ Response 401

    [1177][]

+ Response 404

    [1189][]


## Get [/v1/user/details{?email}]
Get User API gets details of a user.

### Get details of a user [GET]

+ Parameters

    + email: abc@test.com (string, required) - Email Id of the user whose details to be retrieved

+ Request (application/json)

    + Headers

            Accept: application/json
            x-api-key: [Required] Partner specific API key provided by Birdeye for data exchange.

+ Response 200 (application/json)

    + Attributes

        + emailId: abc@test.com (string) - User's email Id.
        + firstName: Ron (string) - User's first name.
        + lastName: Spector (string) - User's last name.
        + phone: 1234 123 123 (string) - User's phone number.
        + businessList (array, fixed) - Accessable Business list
            + (object)
                + businessId: 1234567 (string) - Id of the business.
                + businessName: Drs. Chalker and Peterson, A Dental Partnership (string) - Business Name.
                + businessAlias: Drs. Chalker (string) - Business Alias.

    + Body

            {
                "emailId": "147476560554272@birdeye.com",
                "firstName": "Ron",
                "lastName": "Smith",
                "phone": 1234 123 123,
                "businessList": [
                    {
                        "businessId": 147476560554272,
                        "businessName": "single-location-test-6",
                        "businessAlias": "single-location-test-6"
                    }]
            }

+ Response 401

    [1161][]

+ Response 429

    [89][]

+ Response 404

    [1188][]

+ Response 404

    [1189][]

+ Response 404

    [1010][]




# Group Reviews
Consistently generate more reviews and higher ratings.

## Get [/v1/review/businessId/{businessId}{?sindex,count,includeNonAggregatedReviews}]
Get Reviews returns the list of reviews for an account with all its details.

> __Note__
> - _Deep Pagination with record window greater than 100k is not supported. Either reduce the sindex + count to be less than equal to 100k or use appropriate filters to narrow down your result set._

### Get Reviews [POST]

+ Parameters

    + businessId: 12345678 (number, required) - Id of the Business.
    + sindex: 10 (integer, required) - Start index of the reviews. Refer API note for max permissible value.
    + count: 30 (integer, required) - Number of reviews to query. Refer API note for max permissible value.
    + includeNonAggregatedReviews: false (boolean, optional) - Include Reviews whose auto-crawling is blocked e.g. PressGaney

+ Request (application/json)

    + Headers

            Accept: application/json
            x-api-key: [Required] Partner specific API key provided by Birdeye for data exchange.

    + Attributes
        + fromDate: 04/01/2013 (string) - Review date start in UTC format.
        + toDate: 04/01/2013 (string) - Review date end in UTC format, eg if toDate is 04/01/2013, reviews of date 04/01/2013 is excluded .
        + fromTimestamp: 1712986782000 (number) - Review start date in milliseconds, pass either fromDate or fromTimestamp.
        + toTimestamp: 1715578782000 (number) - Review end date in milliseconds, pass either endDate or toTimestamp.
        + updateFromDate: 04/01/2013 (string) - Review updated date start in UTC format.
        + updateToDate: 04/01/2013 (string) - Review updated date end in UTC format.
        + sources: google (string) - Aggregation source name Note: use "our_website" to filter reviews posted on Birdeye platform or use "direct_feedback" for direct feedback.
        + ratings: 4,5 (array) - Review rating Possible values 0,1,2,3,4,5.
        + searchStr: Great service (string) - String that is contained by review.
        + subBusinessIds: 123456789 ,987654321 (array) - BusinessIds under enterprise account.
        + statuses: published,parked (array) - Review status. Valid values are "published","parked","all". Default is "published" only.
        + allChild: true (boolean) - Get review from all child ignoring merge reviews flag configured at parent/child relationship level.
        + tags: ["top reviews", "need action"] (array) - Reviews with assigned tags
        + fetchExtraParams: false (boolean) - To fetch custom field(s) associated with the customer attributed to the review [if any].
        + needCustomerInfo: false (boolean) - To fetch customer information associated with the reviewer [if attributed].
        + fetchAssitedByDetails: true (boolean) - To retrieve employees associated with the review [if mapped].


    + Body

            {
                "fromTimestamp": 1712986782000,
                "toTimestamp": 1715578782000,
                "updateFromDate":"04/01/2013",
                "updateToDate":"05/3/2015",
                "sources":["google","citysearch"],
                "ratings":[1,2,3,4,5,0],
                "searchStr":"test string",
                "subBusinessIds":[12345678,1232111,1231231321],
                "statuses":["published","parked"],
                "allChild":"true",
                "tags":["positive","negative"],
                "fetchExtraParams":false,
                "needCustomerInfo":false,
                "fetchAssitedByDetails":true

            }

+ Response 200 (application/json)

    + Attributes (array)
        + (object)
            + reviewId: 1858537291 (number) - Id of the review.
            + rating: 5.0 (number) - Overall rating for the review, in case of direct feedback and facebook recommendations it will be 0. For Facebook recommendations, value will be 1, Non recommended review will have value set as 0.
            + comments: Great service, excellent food (string) - User comment.
            + reviewer - Reviewer details
                + firstName: Ron (string) : Reviewer first name.
                + lastName: Spector (string) : Reviewer last name.
                + nickName: Ron Spector (string) : Reviewer full name.
                + thumbnailUrl: https://ddjkm7n7lx.cloudfront.net/reviewer/dc42f6d8b2b84dc0b688c43e616.jpeg (string) : Thumbnail URL
            + sourceType: Direct Feedback (string) - Source of the review if it is an aggregated review.
            + reviewURL: https://www.facebook.com/Imp-Flow-17565744/reviews (string) - Review url
            + reviewDate: Jan 20, 2014 (string) - Review posted date.
            + response: Thanks you for the review (string) - Review response text.
            + responseDate: Jan 20, 2014 (string) - Response date.
            + inlineReplyEnabled: true (boolean) - If true, you can post replies through the dashboard.
            + enableReply: true (boolean) - Whether a review reply is supported via Birdeye API or not.
            + customerId: 123456 (number) - Customer's Id attributed with this review (if any).
            + extraParams (object) - Key value pair of custom field(s) associated with the customer attributed to the review (if any)
            + assitedByUser (object) - Employees associated with the review
                + firstName: Ron (string) : Employee first name.
                + lastName: Spector (string) : Employee last name.
                + emailId: ronspector@test.com (string) : Employee email id.
                + phoneNum: 7123123213 (string) : Employee phone number.

    + Body

            [
                {
                    "reviewId": "1858537291",
                    "rating": 0,
                    "comments": "Ordered earlier today, delivered fast..exactly what I ordered..thank you so much!",
                    "title": null,
                    "reviewer": {
                      "firstName": "Sandy Rowe",
                      "lastName": "Johncox",
                      "nickName": "Sandy Rowe Johncox",
                      "thumbnailUrl": "https://ddjkm7n7lx.cloudfront.net/reviewer/dc42f6d8b2b84dc0b688c43e616.jpeg",
                      "facebookId": "638309687"
                    },
                    "reviewURL": "https://www.facebook.com/Imp-Flow-17565744/reviews",
                    "sourceType": "Facebook",
                    "inlineReplyEnabled": false,
                    "reviewDate": "Jan 20, 2014",
                    "response": "Thanks",
                    "responseDate": "Feb 18, 2014",
                    "recommended": 1
                },
                {
                    "reviewId": "73748574902",
                    "rating": 0,
                    "comments": "I am a long time customer and love Dieici. I am there at least once a week. I have never been disappointed with any service. I love all the girls. The customer service is beyond a 10. I also love the new addition Wish to the salon! Wish is a woman's clothing boutique. What could be better...beauty and fashion all in one spot!!! Dieci keeps getting better and better!",
                    "title": null,
                    "reviewer": {
                      "firstName": "Jennifer",
                      "lastName": "Bennett",
                      "nickName": "Jennifer Bennett",
                      "thumbnailUrl": "http://d2xt3xymj142xp.cloudfront.net/reviewer/9a070cf98f014f5d9b06987dcc9c48fe.jpeg",
                      "emailId": "jbennett@gmail.com",
                      "facebookId": null,
                      "city": "Cedar Knolls",
                      "state": " NJ"
                    },
                    "reviewUrl": "https://birdeye.com/imp-flower-15229573096",
                    "sourceType": "Direct Feedback",
                    "inlineReplyEnabled": true,
                    "reviewDate": "Jan 20, 2019",
                    "response": "Thanks",
                    "responseDate": "Feb 18, 2019",
                    "featured": 0,
                    "customerId": 7432167,
                    "extraParams":{
                        "key1": "value1",
                        "key2": "value2",
                        "key3": "value3"
                    },
                    "assitedByUser": [
                        {
                            "firstName": "Steve",
                            "lastName": "M.",
                            "emailId": "steve@test.com",
                            "phoneNum": ""
                        },
                        {
                            "firstName": "Smith",
                            "lastName": "S.",
                            "emailId": "smith@test.com",
                            "phoneNum": ""
                        }
                    ]
                }
            ]

+ Response 401

    [1161][]

+ Response 429

    [89][]

+ Response 404

    [1011][]

+ Response 400

    [1163][]

+ Response 401

    [1164][]

+ Response 400

    [1167][]

+ Response 4010

    [1186][]

+ Response 400

    [1187][]

+ Response 400

    [1227][]

+ Response 400

    [1228][]

+ Response 400

    [1244][]




## Review Summary [/v1/review/businessid/{businessId}/summary{?statuses}]
Review Summary API returns the number of reviews based on the review source.
It also returns the list of review sources and review ratings.


### Get reviews summary [GET]

+ Parameters

    + businessId: 12345678 (string, required) - Id of the business.
    + statuses: published,parked (string[], optional) -  List of review status.


+ Request (application/json)

    + Headers

            Accept: application/json
            x-api-key: [Required] Partner specific API key provided by Birdeye for data exchange.


+ Response 200 (application/json)

    + Attributes

        + sources (array) - Source detail list.
            + (object)
                + sourceName: Google (string) - Name of the source.
                + sourceAlias: google (string) - Alias of the source.
                + avgRating: 4.6 (number) - Average rating of the source.
                + reviewCount: 15 (number) - Total number of reviews.
        + ratings (array, fixed) - Review count against each possible review rating.
            + (object)
                + rating: 5 (number) -  Review Rating.
                + reviewCount: 140 (number) -  Number of reviews according to rating.

    + Body

            {
                "sources": [
                {
                    "sourceName": "Birdeye",
                    "sourceAlias": "birdeye",
                    "avgRating": 4.6,
                    "reviewCount": 15
                },
                {
                    "sourceName": "Citysearch",
                    "sourceAlias": "citysearch",
                    "avgRating": 5,
                    "reviewCount": 3
                },
                {
                    "sourceName": "GooglePlay",
                    "sourceAlias": "googleplay",
                    "avgRating": 4.5,
                    "reviewCount": 742
                },
                {
                    "sourceName": "PressGaney",
                    "sourceAlias": "pressGaney",
                    "avgRating": 4,
                    "reviewCount": 2
                }]
                "ratings": [
                {
                    "rating": 0,
                    "reviewCount": 0,
                },
                {
                    "rating": 1,
                    "reviewCount": 4,
                },
                {
                    "rating": 2,
                    "reviewCount": 34,
                },
                {
                    "rating": 3,
                    "reviewCount": 46,
                },
                {
                    "rating": 4,
                    "reviewCount": 103,
                },
                {
                    "rating": 5,
                    "reviewCount": 92,
                }]
            }

+ Response 401

    [1161][]

+ Response 429

    [89][]

+ Response 404

    [1011][]


+ Response 400

    [1167][]


## Review Reply [/v1/review/reply/business/{businessNumber}/review/{reviewId}]
Eligible reviews can be replied to from the Birdeye platform using Review Reply API.

### Post Review Reply [PUT]

+ Parameters

    + businessNumber: 169744180007807 (string, required) - Id of the business.
    + reviewId: 88778877 (string, required) - Review Id.

+ Request (application/json)

    + Headers

            Accept: application/json
            x-api-key: [Required] Partner specific API key provided by Birdeye for data exchange.

    + Attributes
        + response: Thanks for reviewing us (string) - Review Reply text to be posted.
        + isPrivateResponse: Default user (string) - Flag to post reply privately to reviewer [Only in case of Managed Service].

    + Body

            {
                "response":"Enter Reply here",
                "isPrivateResponse":false
            }

+ Response 200 (application/json)

    + Attributes

        + response: Thanks for reviewing us (string) - Review Reply text that is posted.
        + responseBy: Default user (string) - Default user (static value)
        + responseDate: 1604926421189 (string) - Reply posted date in millis.

    + Body

            {
                "response":"Thanks for reviewing us.",
                "responseBy":"Default user",
                "responseDate": 1604926421189
            }

+ Response 401

    [1167][]

+ Response 401

    [1161][]

+ Response 400

    [1011][]

+ Response 404

    [1175][]

+ Response 400

    [1042][]

+ Response 400

    [2110][]

+ Response 400

    [21101][]

+ Response 400

    [21103][]

+ Response 400

    [21104][]

+ Response 400

    [2111][]

+ Response 400

    [21113][]

+ Response 400

    [21114][]

+ Response 400

    [21112][]

+ Response 400

    [2222][]

+ Response 400

    [1541][]

+ Response 400

    [2075][]

+ Response 400

    [20706][]

+ Response 400

    [2078][]


## Create Tags [/v1/tag{?businessId}]
Create Tags creates new tag(s) in the account.

### Create tags [POST]

+ Parameters

    + businessId: 12345678 (string, required) - Id of the Business.


+ Request (application/json)

    + Headers

            Accept: application/json
            x-api-key: [Required] Partner specific API key provided by Birdeye for data exchange.

    + Attributes
        + tags: positive, spam (array) - List of tag name.


    + Body

            {
                "tags" : [ "positive", "spam" ]
            }

+ Response 200 (application/json)

+ Response 401

    [1161][]

+ Response 429

    [89][]

+ Response 401

    [1167][]

+ Response 404

    [1011][]



## Delete Tag [/v1/tag/{tagname}{?businessId}]
Delete Tag deletes any tag from the account.

### Delete a tag [DELETE]

+ Parameters

    + businessId: 12345678 (string, required) - Business Number.
    + tagname: positive2022 (string, required) - Tag name to be deleted.


+ Request (application/json)

    + Headers

            Accept: application/json
            x-api-key: [Required] Partner specific API key provided by Birdeye for data exchange.

+ Response 200 (application/json)

+ Response 401

    [1161][]

+ Response 429

    [89][]

+ Response 401

    [1167][]

+ Response 404

    [1011][]



## Fetch Tags [/v1/tag/all{?businessId}]
Fetch Tags returns the list of tags associated with the account.

### Get all tags [GET]


+ Parameters

    + businessId: 12345678 (string, required) - Business Number.


+ Request (application/json)

    + Headers

            Accept: application/json
            x-api-key: [Required] Partner specific API key provided by Birdeye for data exchange.

+ Response 200 (application/json)


    + Body

            [ "dental", "dentist", "doctor", "ortho" ]

+ Response 401

    [1161][]

+ Response 429

    [89][]

+ Response 401

    [1167][]

+ Response 404

    [1011][]



## Search reviews and assign tags [/v1/tag/add/review{?bid,tag}]
Assign the list of tags to the reviews on the basis of review filter.

### Assign tags to filtered reviews [POST]


+ Parameters

    + bid: 12345678 (string, required) - Id of the Business.
    + tag: positive2022&negative2022 (string, required) - List of tags.


+ Request (application/json)

    + Headers

            Accept: application/json
            x-api-key: [Required] Partner specific API key provided by Birdeye for data exchange.

    + Attributes
            + reviewIds: 3901784402334,3901744402337 (array) - List of reviewIds.
            + fromDate: 04/01/2021 (string) - Review Start date format MM/dd/YYYY.
            + toDate: 05/03/2022 (string) - Review End date format MM/dd/YYYY.
            + updateFromDate: 04/01/2021 (string) - Review update from date format MM/dd/YYYY.
            + updateToDate: 05/3/2022 (string) - Review update end date format MM/dd/YYYY.
            + sources: google,citysearch (string) - List of sources.
            + ratings: 1,2,3,4,5,0 (string) - List of Review Ratings.
            + keywords: water,great (string) - List Review keywords.
            + searchStr: Awesome (string) - Search string.
            + subBusinessIds: 134387654345,134387654346 (string) - List of location numbers.


    + Body

            {
                "reviewIds":["3901784402334","3901744402337","3902344402875"],
                "fromDate":"04/01/2013",
                "toDate":"05/3/2015",
                "updateFromDate":"04/01/2013",
                "updateToDate":"05/3/2015",
                "sources":["google","citysearch"],
                "ratings":[1,2,3,4,5,0],
                "keywords":["water"],
                "searchStr":"Awesome",
                "subBusinessIds":[134387654345,134387654346,13438765437]
            }


+ Response 200 (application/json)

+ Response 401

    [1161][]

+ Response 429

    [89][]

+ Response 401

    [1167][]

+ Response 404

    [1011][]




## Search reviews and remove tags [/v1/tag/remove/review{?bid,tag}]
Search reviews and remove tags removes the list of tags from reviews on the basis of review filter.

### Remove tags from filtered reviews [POST]


+ Parameters

    + bid: 12345678 (string, required) - Id of the Business.
    + tag: positive2022&negative2022 (string, required) - List of tags to be removed from reviews.


+ Request (application/json)

    + Headers

            Accept: application/json
            x-api-key: [Required] Partner specific API key provided by Birdeye for data exchange.

    + Attributes
            + reviewIds: 3901784402334,3901744402337 (array) - List of reviewIds.
            + fromDate: 04/01/2021 (string) - Review Start date format MM/dd/YYYY.
            + toDate: 05/03/2022 (string) - Review End date format MM/dd/YYYY.
            + updateFromDate: 04/01/2021 (string) - Review update from date format MM/dd/YYYY.
            + updateToDate: 05/3/2022 (string) - Review update end date format MM/dd/YYYY.
            + sources: google,citysearch (string) - List of sources.
            + ratings: 1,2,3,4,5,0 (string) - List of Review Ratings.
            + keywords: water,great (string) - List Review keywords.
            + searchStr: Awesome (string) - Search string.
            + subBusinessIds: 134387654345,134387654346 (string) - List of location numbers.


    + Body

            {
                "reviewIds": [3901784402334,3901744402337],
                "fromDate":"04/01/2013",
                "toDate":"05/3/2015",
                "updateFromDate":"04/01/2013",
                "updateToDate":"05/3/2015",
                "sources":["google","citysearch"],
                "ratings":[1,2,3,4,5,0],
                "keywords":["water"],
                "searchStr":"Awesome",
                "subBusinessIds":[134387654345,134387654346,13438765437]
            }


+ Response 200 (application/json)

+ Response 401

    [1161][]

+ Response 429

    [89][]

+ Response 401

    [1167][]

+ Response 404

    [1011][]


## Remove tags from all reviews [/v1/tag/remove/all/review{?bid}]
Remove particular tags from all reviews removes the list of tags from all the reviews of an account.

### Remove particular tags from all reviews [POST]

+ Parameters

    + bid: 12345678 (string, required) - Id of the Business.


+ Request (application/json)

    + Headers

            Accept: application/json
            x-api-key: [Required] Partner specific API key provided by Birdeye for data exchange.

    + Attributes
        + tags: happy,good (array) - List of tags to be removed.


    + Body

            {
                "tags":["happy","good","smile"]
            }


+ Response 200 (application/json)

+ Response 401

    [1161][]

+ Response 429

    [89][]

+ Response 401

    [1167][]

+ Response 404

    [1011][]



# Group Contact

Manage contacts across locations effortlessly with a robust Contact Management System.

## Create or Update Contact [/v1/customer-v2/external/saveCustomer{?businessId}]
Customers can be created & updated using Create or Update Contact API.


### Create or Update Contact [POST]

+ Parameters

    + businessId: 12345678 (string, required) - Id of the business.


+ Request (application/json)

    + Headers

            Accept: application/json
            x-api-key: [Required] Partner specific API key provided by Birdeye for data exchange.


    + Attributes


        + id: 115339282 (string) - Id of enterprise customer.
        + firstName: Ron (string) - First name of the customer.
        + lastName: Spector (string) - Last name of the customer.
        + email: ron@test.con (string) - Email of customer, optional (if phone is provided).
        + phone: 123 456 7890 (string) - Phone of customer optional (if email is provided).
        + countryCode: US (string, optional) - Country code of the phone number. Default value=US, Other Possible values=AU,CA,MX,PR,VI
        + smsOptin: false (boolean) - SMS Opt flag.
        + emailOptin: false (boolean) - Email Opt flag.
        + blocked: false (boolean) - Contact block flag.
        + businessIds: 145308764185002,145308769721320 (array) - Business Ids under enterprise account. The Business Ids field is mandatory while creating a new contact. While updating, if no business Ids are provided, the same location mappings are retained.
        + tags: Tag One, Tag Two (string) - List of tags.
        + customFields (array) - List of Custom fields. We currently support 4 types of customfields - text, number, currency, date (in formats - “MM/dd/yyyy” and "MM-dd-yyyy" only), and yes or no (1:"yes", 0:"no").
            + (object)
                + fieldName: Company (string) - Field name.
                + type: text (string) - Field type.
                + fieldValue: Dunder Mifflin (string) - Value of field.
        + externalId: ABC123 (string) - Unique external identifier of the contact which could be from the CRM or any external system storing your contacts.

    + Body

            {
                "id": 115339282,
                "firstName": "Michael",
                "lastName": "Scott",
                "email": "michael@test.com",
                "phone": "(212) xxx-xxxx",
                "countryCode": "US",
                "emailOptin": true,
                "smsOptin": true,
                "blocked": false,
                "businessIds": [161458406365307,161072537475129],
                "tags": ["Tag One","Tag Two"],
                "customFields": [
                {
                    "fieldName": "Company",
                    "type": "text",
                    "fieldValue": "Dunder Mifflin"
                },
                {
                    "fieldName": "Product",
                    "type": "text",
                    "fieldValue": "Paper"
                }],
                "externalId": "ABC123"
            }


+ Response 200 (application/json)

    + Attributes
        + id: 115339282 (number) - Id of enterprise customer.

    + Body

            {
                "id": 115339282
            }


+ Response 401

    [1161][]

+ Response 429

    [89][]


+ Response 400

    [1167][]


+ Response 404

    [1532][]

+ Response 400

    [5008][]

+ Response 400

    [5043][]



## Get Contact [/v1/customer-v2/external/getCustomer{?businessId}]
Get Contact fetches Customer details.

### Get Contact [POST]


+ Parameters
    + businessId: 12345678 (string, required) - Id of the business.


+ Request (application/json)

    + Headers

            Accept: application/json
            x-api-key: [Required] Partner specific API key provided by Birdeye for data exchange.

    + Attributes

        + id: 115339282 (string) - Id of enterprise customer. optional (if cid, phone or email is provided).
        + cid: 293847172 (string) - Id of customer mapping on a location. optional (if id, phone or email is provided).
        + email: ron@test.con (string) - Email of customer, optional (if phone, id or cid is provided).
        + phone: 123 456 7890 (string) - Phone of customer optional (if email, id or cid is provided).


    + Body

            {
                "id": 115339282,
                "cid": 293847172,
                "email": "test.user@test.com",
                "phone": "(212) xxx-xxxx"
            }

+ Response 200 (application/json)

    + Attributes


        + id: 115339282 (string) - Id of enterprise customer.
        + firstName: Ron (string) - First name of the customer.
        + lastName: Spector (string) - Last name of the customer.
        + email: ron@test.con (string) - Email of customer, optional (if phone is provided).
        + phone: 123 456 7890 (string) - Phone of customer optional (if email is provided).
        + countryCode: US (string) - Country code of the phone number. Default value=US, Other Possible values=AU,CA,MX,PR,VI
        + smsOptin: false (boolean) - SMS Opting flag.
        + mappings (array) - List of locations where customer is mapped. If requested by cid, only that location's mapping is returned.
            + (object)
                + cid: 12345 (number) - Customer location id.
                + location: New York (string) - Name of the location.
                + bid: 710687 (number) - Location id.
                + businessNumber: 169744180007807 (number) - Location Number.
        + tags: Tag One, Tag Two (string) - List of tags.
        + customFields (array) - List of Custom fields.
            + (object)
                + fieldName: Company (string) - Field name.
                + type: text (string) - Field type.
                + fieldValue: Dunder Mifflin (string) - Value of field.
        + externalId: ABC123 (string) - Unique external identifier of the contact which could be from the CRM or any external system storing your contacts.


    + Body

            {
                "id": 115339282,
                "firstName": "Michael",
                "lastName": "Scott",
                "email": "test.user@test.com",
                "phone": "(212) xxx-xxxx",
                "countryCode": "US",
                "blocked": false,
                "emailOtin": true,
                "smsOptin": true,
                "source": "api",
                "created": "January 12, 2021",
                "mappings": [
                {
                    "cid": 1234451,
                    "location": "new horizon",
                    "bid": 710687,
                    "businessNumber": 161458406365307
                },
                {
                    "cid": 1235452,
                    "location": "North Carolina",
                    "bid": 714169,
                    "businessNumber": 161072537475129
                }],
                "tags": ["Tag One","Tag Two"],
                "customFields": [
                {
                    "fieldName": "Company",
                    "type": "text",
                    "fieldValue": "Dunder Mifflin"
                },
                {
                    "fieldName": "Product",
                    "type": "text",
                    "fieldValue": "Paper"
                }],
                "externalId": "ABC123"
            }

+ Response 401

    [1161][]

+ Response 429

    [89][]

+ Response 400

    [1167][]

+ Response 404

    [1532][]

+ Response 400

    [5043][]



## Delete Contact [/v1/customer-v2/external/deleteCustomer{?businessId}]
Customers can be deleted using Delete Contact API.


### Delete Contact [POST]

+ Parameters

    + businessId: 12345678 (string, required) - Id of the business.


+ Request (application/json)

    + Headers

            Accept: application/json
            x-api-key: [Required] Partner specific API key provided by Birdeye for data exchange.

    + Attributes
        + id: 115339282 (string,required) - Id of enterprise customer.
        + businessIds: 161322681923726, 161322681923727 (array) - List of business Ids. If businessIds are provided, mappings would be deleted from those locations only. If no businessIds are provided, the customer would be deleted from all the locations.

    + Body

            {
                "id": 115339282,
                "businessIds": [161322681923726, 161322681923727]
            }


+ Response 200 (application/json)

+ Response 401

    [1161][]

+ Response 404

    [1532][]

+ Response 400

    [5043][]



## Check in [/v1/customer/checkin{?bid}]
Customer check-in can be done using Check in API.


### Customer Checkin [POST]

+ Parameters

    + bid: 12345678 (string, required) - Id of the business.


+ Request (application/json)

    + Headers

            Accept: application/json
            x-api-key: [Required] Partner specific API key provided by Birdeye for data exchange.

    + Attributes
        + name: Steve Smith  (string) - Name of the customer.
        + emailId: steves@abcd.com (string) - Email ID of the customer (optional If business has enabled for sms, then either email or phone will be required).
        + phone: 4081231234 (string) - Phone number of the customer (optional If business has enabled for sms, then either email or phone will be required).
        + smsEnabled: 0 (number) - Whether customer has opted to receive SMS request or not. Valid values are 0(false), 1(true). Default is 1.
        + additionalParams (object) - Custom tags can be added as key value pair.
        + employees (array)
            + (object)
                + emailId: sshikha@abcd.com (string) - Email Id of assisted Employee.
        + externalId: ABC123 (string) - Unique external identifier of the contact which could be from the CRM or any external system storing your contacts.

    + Body

            {
              "name": "Steve Smith",
              "emailId": "steves@abcd.com",
              "phone": "408-xxx-xxxx",
              "smsEnabled": 1,
              "additionalParams" :
               {
                    "Tag Group Name 1": "Tag Name 1",
                    "Tag Group Name 2" :"Tag Name 2",
                    "location" :"New York"
               },
              "employees":[{
                             "emailId" : "sshikha@abcd.com"
                          }],
              "externalId": "ABC123"
            }

+ Response 200 (application/json)

    + Attributes
        + customerId: 673356544  (number) - Id of enterprise customer.


    + Body

            {
                "customerId":”673356544”
            }

+ Response 400

    [1142][]

+ Response 400

    [1086][]

+ Response 400

    [1087][]


+ Response 400

    [1088][]


+ Response 400

    [1055][]


+ Response 400

    [1170][]

+ Response 401

    [1033][]

+ Response 401

    [1161][]

+ Response 429

    [89][]

+ Response 401

    [1167][]

+ Response 401

    [1175][]



## Activity log [/v1/customer/history/{customerId}{?businessId,startDate,endDate}]
You can retrieve the customer history or customer activity log using the Customer activity log API.

### Customer activity log [GET]

+ Parameters

    + businessId: 12345678 (string, required) - Id of the business.
    + startDate: 12/30/2021 (string, optional) - The start date format should be MM/dd/yyyy. if start date is not set, then we will use the date customer was created.
    + endDate: 12/30/2022 (string,optional) - The end date format should be MM/dd/yyyy. if end date is not set, then we will use the current date.
    + customerId: 12344 (string,required) - Id of the customer.


+ Request (application/json)

    + Headers

            Accept: application/json
            x-api-key: [Required] Partner specific API key provided by Birdeye for data exchange.

+ Response 200 (application/json)

    + Attributes (array)
        + (object)
            + type: Review request email (string) - Activity Type.
            + activityDate: Review request email (string) - Activity Type.
            + action: Sent (string) -  Action performed on the activity type.
            + activityTimestamp: 1435290249000 (number) - Epoc activity timestamp.


    + Body

            [{
                "type": "Share review email",
                "activityDate": "Mar 11, 2018 08:44 PM",
                "action": "Sent",
                "activityTimestamp": 1435290249000
            },
            {
                "type": "Review request email",
                "activityDate": "Mar 12, 2018 08:43 PM",
                "action": "Sent",
                "activityTimestamp": 1435290234000
            },
            {
                "type": "Review request email",
                "activityDate": "Mar 13, 2018 08:43 PM",
                "action": "5-star review written on Birdeye",
                "activityTimestamp": 1435290234000
            },
            {
                "type": "Created",
                "activityDate": "Mar 13, 2018 08:43 PM",
                "action": "No Action",
                "activityTimestamp": 1435290234000
            }]

+ Response 404

    [1011][]

+ Response 401

    [1161][]

+ Response 429

    [89][]

+ Response 401

    [1167][]

+ Response 400

    [1089][]

+ Response 400

    [1091][]

+ Response 400

    [1523][]

+ Response 400

    [1524][]


## Delete Customer [/v1/customer/id/{customerId}]
Customer can be deleted using this API.

### Customer Delete [DELETE]

+ Parameters

    + customerId: 12345678 (string, required) - Id of enterprise customer.

+ Request (application/json)

    + Headers

            Accept: application/json
            x-api-key: [Required] Partner specific API key provided by Birdeye for data exchange.

+ Response 200 (application/json)

    + Attributes
        + email: ron@test.com (string) - Email Id of the customer.
        + firstName: Ron Smith (string) - First name of the customer.
        + number: 411504416 (string) -  Phone number of the customer.


    + Body

            {
                "emailId": "tom@abcd.com",
                "firstName": "tom",
                "number": "411504416"
            }

+ Response 404

    [1011][]

+ Response 401

    [1161][]

+ Response 429

    [89][]

+ Response 401

    [1167][]


+ Response 400

    [1089][]



## Subscribe/Unsubscribe Customer [/v1/customer-v2/change-permission]
Customer can be subscribe/unsubscribe from Email & SMS using this API.


### Subscribe/Unsubscribe Customer [POST]


+ Request (application/json)

    + Headers

            Accept: application/json
            x-api-key: [Required] Partner specific API key provided by Birdeye for data exchange.

    + Attributes
        + permission: both-unsubscribed (string, required) -  Action to be taken. Valid values are both-subscribed, both-unsubscribed, sms-subscribed, and email-subscribed.
        + email: test1@mail.in, ron@test.com (array) - Customer email ids.
        + phone: 2345654326, 1234567890 (array) - Customer phone numbers.
        + accountNumber: 123456789876543 (number, required) - Location id.

    + Body

            {
                "permission" : "both-unsubscribed",
                "email": ["test1@mail.in"],
                "phone": ["2345654326"],
                "accountNumber":123456789876543
            }

+ Response 200 (application/json)


    + Body

            true or false


+ Response 404

    [1011][]

+ Response 401

    [1161][]

+ Response 429

    [89][]

+ Response 401

    [1167][]


+ Response 400

    [1089][]



## Contacts list [/v2/customer/list{?businessId,page,size,order,sortby}]
Contact list API fetches contact list for a business.

### Contact [POST]

+ Parameters

    + businessId: 12345678 (string, required) - Id of the Business.
    + page: 0 (number, required) - The page number.
    + size: 30 (number, required) - Maximum number of contacts return in response.
    + sortby: lastActivityOn (string, required) - The sorting order of the list.

+ Request (application/json)

    + Headers

            Accept: application/json
            x-api-key: [Required] Partner specific API key provided by Birdeye for data exchange.

    + Attributes

        + startDate: 07/01/2019 (string, optional) - Start Date in format mm/dd/yyyy
        + endDate: 07/19/2019 (string, optional) - End Date in format mm/dd/yyyy

    + Body

            {
                "startDate" : "07/01/2019",
                "endDate" : "07/19/2019"
            }

+ Response 200 (application/json)

    + Attributes

        + page: 0 (number) - The page number.
        + size: 25 (number) - Maximum number of contacts return in response.
        + totalPages: 68 (number) - Number of pages to query.
        + totalCount: 1679 (number) - Number of contacts to query.
        + customers (array) - Customer list
            + (object)
                + customerId: 12345 (number) - Id of enterprise customer.
                + name: Ron Smith (string) - Name of enterprise customer.
                + email: ron@test.com (string) - Email Id of enterprise customer.
                + phone: 1234567890 (string) - Phone number of enterprise customer.
                + lastActivityWithTime: 12 Aug 2019 02:05 PM PDT (string) - Last activity time.



    + Body

            {
                "page": 0,
                "size": 25,
                "totalPages": 68,
                "totalCount": 1679,
                "customers":
                [{
                    "customerId": 12345,
                    "name": "Dummy1",
                    "email": "sam@gmail.com",
                    "phone": "xxx-xxx-xxxx",
                    "lastActivityWithTime": "12 Aug 2019 02:05 PM PDT"
                },
                {
                    "customerId": 54321,
                    "name": "Summy2",
                    "email": "samuel@gmail.com",
                    "phone": "xxx-xxx-xxxx",
                    "lastActivityWithTime": "12 Aug 2019 02:05 PM PDT"
                }]
            }

+ Response 404

    [1011][]

+ Response 401

    [1161][]

+ Response 429

    [89][]

+ Response 401

    [1167][]



## Customer or Lead list [/v1/contact/details{?tags,customfields}]
Customer or Lead list fetches the contact list for a business, which can be filtered based on contact type (Lead or Customer) & source of the contact.

### Customer or Lead list [POST]

+ Parameters

    + tags: true (boolean, optional) - If tag data is required send true, default value is false.
    + customfields: true (boolean, optional) - If custom fields data is required send true, default is false.

+ Request (application/json)

    + Headers

            Accept: application/json
            x-api-key: [Required] Partner specific API key provided by Birdeye for data exchange.

    + Attributes
        + sources: api,dashboard (array, optional) - Source of the customer/lead. Possible values are api,dashboard,facebook,integration,sftp,bulkupload,webchat,crmimport,other,referral,voicecall,text,email,google.
        + startDateUtc: 10/01/2020 (string, required) - Start date in format mm/dd/yyyy.
        + endDateUtc: 10/01/2021 (string, required) - End date in format mm/dd/yyyy.
        + contactType: customer (string, optional) - Possible values are "lead", "customer".  If blank then all contact types are returned.
        + businessId: 158629168202762 (number, required) - Business number of the location, when enterprise number is provided, then fetch data for all locations.
        + page: 0 (string, required) - Page number to request.
        + size: 100 (string, required) - Number of records per page, max is 5000.


    + Body

            {
                "sources": ["api", "dashboard", "facebook", "integration", "sftp", "bulkupload", "webchat", "crmimport", "other", "referral", "voicecall", "text", "email", "google"],
                "startDateUtc": "10/01/2020",
                "endDateUtc": "11/01/2021",
                "contactType": "customer",
                "businessId": 158629168202762,
                "page": 0,
                "size": 100
            }


+ Response 200 (application/json)

     + Attributes
        + page: 0 (number) - Page number to request.
        + size: 100 (number) - Number of records per page.
        + totalPages: 310 (number) - Total number of pages.
        + contacts (array) - Contact details
            + (object)
                + firstName: Ron (string) - First name of the contact.
                + lastName: customer (string) - Last name of the contact.
                + email: ron@test.com (string) - Email Id of the contact.
                + phone: 1234567890 (string) - Phone number of the contact.
                + created: 2021-01-06T22:25:12.000+0000 (string) - Created date of the contact.
                + contactType: customer (string) - Contact type.
                + source: facebook (string) - Source of the customer/lead.
                + mappings (array) - Locations customer/lead is associated with
                    + (object)
                        + businessId: 158629168202762 (number) - Business number of the location.
                        + customerId: 123121 (number) - Id of the customer.



    + Body

            {
                "page":0,
                "size":100,
                "totalPages":310,
                "totalCount":30983,
                "contacts":
                [{
                    "firstName":"Dummy1F",
                    "lastName":"Dummy1L",
                    "email":"sam@gmail.com",
                    "phone":"xxx-xxx-xxxx",
                    "created":"2021-01-06T22:25:12.000+0000",
                    "contactType":"customer",
                    "source":"facebook",
                    "mappings" :
                    [{
                        "businessId" : 123456789909,
                        "customerId" : 2341
                    },
                    {
                        "businessId" : 123456789910,
                        "customerId" : 2342
                    }]
                },
                {
                    "firstName":"Dummy2F",
                    "lastName":"Dummy2L",
                    "email":"samuel@gmail.com",
                    "phone":"",
                    "created":"2021-01-06T22:06:41.000+0000",
                    "contactType":"lead",
                    "source":"webchat",
                    "mappings" :
                    [{
                        "businessId" : 123456789909,
                        "customerId" : 2343
                    }]
                }]
            }


+ Response 404

    [1175][]

+ Response 401

    [1161][]

+ Response 429

    [89][]

+ Response 401

    [1167][]

+ Response 400

    [21121][]

+ Response 400

    [21120][]

+ Response 400

    [21122][]

+ Response 400

    [2347][]

+ Response 400

    [2348][]


## Contact Us [/v1/contactUs/{businessId}]
Contact Us form can be integrated with Birdeye Inbox using Contact Us API.

### Contact Us Request [POST]

+ Parameters

    + businessId: 12345678 (string, required) - Id of the business.

+ Request (application/json)

    + Headers

            Accept: application/json
            x-api-key: [Required] Partner specific API key provided by Birdeye for data exchange.

    + Attributes
        + customerComment: What all services do you offer? (string) - Comment or query by the customer
        + customer (object,required) - Customer details.
            + name: Ron Smith (string, required) - Name of the customer.
            + emailId: ron@test.com (string) - Email Id of the Customer. Mandatory if phone not provided.
            + phone: 1234567890 (string) - Phone No of the Customer. Mandatory if email not provided.
        + additionalParams (object) - Additional Params contains (key,value) pair which can be used to track the customers.


    + Body

            {
                "customerComment": "What all services do you offer?",
                "customer": {
                    "name": "Dummy Name",
                    "emailId": "sam@gmail.com",
                    "phone": "4424242424"
                },
                "additionalParams": {
                "channel": "Web",
                "utm_campiagn": "New Year"
                }
            }

+ Response 200 (application/json)

    + Attributes
        + customerId: 1234567 (number) - Id of the enterprise customer.

    + Body

            {
                "customerId":1234567
            }


+ Response 404

    [1175][]


+ Response 401

    [1161][]

+ Response 429

    [89][]

+ Response 401

    [1167][]

+ Response 400

    [1001][]

+ Response 400

    [1021][]

+ Response 400

    [1087][]

+ Response 400

    [1088][]

+ Response 400

    [1089][]

+ Response 400

    [1142][]

+ Response 400

    [5046][]


## Get opt-out Contacts [/v1/contact/{businessId}/update-feed]
API to fetch the daily opt-out or blocked contact data for a business

### Get opt-out contact data [POST]

+ Parameters

    + businessId: 123456 (number, required) - Id of a business (Long).

+ Request (application/json)

    + Headers

            Accept: application/json
            x-api-key: [Required] Partner specific API key provided by Birdeye for data exchange.


    + Attributes
        + start: 1693570640000 (number, required) - The start date format should be in milliseconds. If the start date is not set and the end date is provided, we will fetch data for 24 hours before the end date. If both are not provided, the latest 24 hours data will be fetched.
        + end: 1693657040000 (number,required) -  The end date format should be in milliseconds. If the end date is not set and the start date is provided, we will fetch data for 24 hours after the start date. If both are not provided, the latest 24 hours data will be fetched.
        + subscriptionStatus: 155911947195757, 155290409184734 (array,required) - Type of subscription update feed we want the data for. Like opted-out to get email and text optouts, and blocked for contacts getting blocked. If not provided, only opted-out updates will be returned, by default.




    + Body

            {
                "end": 1693657040000,
                "start": 1693570640000,
                "subscriptionStatus": [ "blocked","opted-out" ]
            }

+ Response 200 (application/json)


    + Attributes

        + emailOptOut (array) - All the contacts grouped under this field, which were opted out from email in the given duration
            + (object)
                + id: 1213422 (number) - id of the enterprise customer.
                + firstName: John (string) - First name of the contact.
                + lastName: Doe (string) - Last name of the contact.
                + emailId: john@yahoo.com (string) - EmailId of the contact, if exists.
                + phone (string) - Phone number of the contact, if exists. Format is (xxx) xxx-xxxx.
        + textOptOut (array) - All the contacts grouped under this field, which were opted out from text in the given duration
            + (object)
                + id: 1213422 (number) - id of the enterprise customer.
                + firstName: John (string) - First name of the contact.
                + lastName: Doe (string) - Last name of the contact.
                + emailId: john@yahoo.com (string) - EmailId of the contact, if exists.
                + phone (string) - Phone number of the contact, if exists. Format is (xxx) xxx-xxxx.
        + blocked (array) - All the contacts grouped under this field, which were blockedl in the given duration.
            + (object)
                + id: 1213422 (number) - id of the enterprise customer.
                + firstName: John (string) - First name of the contact.
                + lastName: Doe (string) - Last name of the contact.
                + emailId: john@yahoo.com (string) - EmailId of the contact, if exists.
                + phone (string) - Phone number of the contact, if exists. Format is (xxx) xxx-xxxx.


    + Body

            {
              "emailOptOut": [
                {
                  "id": 1213422,
                  "firstName": "John",
                  "lastName": "Doe",
                  "emailId": "john@yahoo.com",
                  "phone": "(212) 234-1242"
                },
                {
                  "id": 1213423,
                  "firstName": "Johnny",
                  "lastName": "Doe",
                  "emailId": "johnny@yahoo.com",
                  "phone": "(212) 231-1242"
                }
              ],
              "textOptOut": [
                {
                  "id": 1213425,
                  "firstName": "Jane",
                  "lastName": "Doe",
                  "emailId": "john@yahoo.com",
                  "phone": "(212) 234-1242"
                },
                {
                  "id": 1213423,
                  "firstName": "Johnny",
                  "lastName": "Doe",
                  "emailId": "johnny@yahoo.com",
                  "phone": "(212) 231-1242"
                }
              ],
              "blocked": [
                {
                  "id": 1213422,
                  "firstName": "John",
                  "lastName": "Doe",
                  "emailId": "john@yahoo.com",
                  "phone": "(212) 234-1242"
                },
                {
                  "id": 1213423,
                  "firstName": "Johnny",
                  "lastName": "Doe",
                  "emailId": "johnny@yahoo.com",
                  "phone": "(212) 231-1242"
                }
              ]
            }


+ Response 401

    [1161][]

+ Response 401

    [1011][]

+ Response 429

    [89][]

+ Response 400

    [20083][]


# Group Contact V2

Easily manage contacts across multiple locations using enhanced Contact APIs, featuring built-in support for communication preference flags.

## Upsert Contact [/v1/contact/external/preferences/saveCustomer]
Customers can Create or Update Contact API.

### Upsert Contact [POST]


+ Request (application/json)

    + Headers

            Accept: application/json
            x-api-key: [Required] Partner specific API key provided by Birdeye for data exchange.
            x-business-number: [Required] User assosiated businessNumber

    + Attributes


        + id: 115339282 (string) - Id of enterprise customer.
        + firstName: Ron (string) - First name of the customer.
        + lastName: Spector (string) - Last name of the customer.
        + email: ron@test.con (string) - Email of customer, optional (if phone is provided).
        + phone: 123 456 7890 (string) - Phone of customer optional (if email is provided).
        + countryCode: US (string, optional) - Country code of the phone number. Default value=US, Other Possible values=AU,CA,MX,PR,VI
        + smsOptin: false (boolean) - SMS Opt flag.
        + blocked: false (boolean) - Contact block flag.
        + businessIds: 145308764185002,145308769721320 (array) - Business Ids under enterprise account. The Business Ids field is mandatory while creating a new contact. While updating, if no business Ids are provided, the same location mappings are retained.
        + tags (array[string]) - List of tags
            + Tag One
            + Tag Two
        + customFields (array) - List of Custom fields. We currently support 4 types of customfields - text, number, currency, date (in formats - “MM/dd/yyyy” and "MM-dd-yyyy" only), and yes or no (1:"yes", 0:"no").
            + (object)
                + fieldName: Company (string) - Field name.
                + type: text (string) - Field type.
                + fieldValue: Dunder Mifflin (string) - Value of field.
        + externalId: ABC123 (string) - Unique external identifier of the contact which could be from the CRM or any external system storing your contacts.
        + emailPreferences (object) - Email communication preference flags.
            + marketingOptin: true (boolean) - Marketing communication.
            + feedbackOptin: true (boolean) - Feedback communication.
            + serviceOptin: true (boolean) - Service communication.
        + smsPreferences (object) - SMS communication preference flags.
            + marketingOptin: true (boolean) - Marketing communication.
            + feedbackOptin: true (boolean) - Feedback communication.
            + serviceOptin: true (boolean) - Service communication.


    + Body

            {
                "id": 115339282,
                "firstName": "Michael",
                "lastName": "Scott",
                "email": "michael@test.com",
                "phone": "(212) xxx-xxxx",
                "countryCode": "US",
                "smsOptin": true,
                "blocked": false,
                "businessIds": [161458406365307,161072537475129],
                "tags": ["Tag One","Tag Two"],
                "customFields": [
                {
                    "fieldName": "Company",
                    "type": "text",
                    "fieldValue": "Dunder Mifflin"
                },
                {
                    "fieldName": "Product",
                    "type": "text",
                    "fieldValue": "Paper"
                }],
                "externalId": "ABC123",
                "emailPreferences": {
                    "marketingOptin": true,
                    "feedbackOptin": true,
                    "serviceOptin": true
                },
                "smsPreferences": {
                    "marketingOptin": true,
                    "feedbackOptin": true,
                    "serviceOptin": true
                }
            }


+ Response 200 (application/json)

    + Attributes
        + id: 115339282 (number) - Id of enterprise customer.

    + Body

            {
                "id": 115339282
            }

+ Response 400 (application/json)

    + Body

            {
                "code": 20099,
                "message": "Text Communication categorisation is not enabled please use smsOptin flag"
            }

+ Response 400

    [1167][]

+ Response 400

    [5008][]

+ Response 400

    [5043][]

+ Response 401

    [1161][]

+ Response 429

    [89][]


+ Response 400

    [1167][]


+ Response 404

    [1532][]

+ Response 400

    [5008][]

+ Response 400

    [5043][]


## Retrieve Contact [/v1/contact/external/preferences/getCustomer]
Retrieve a customer's contact profile and associated details.

### Retrieve Contact [POST]


+ Request (application/json)

    + Headers

            Accept: application/json
            x-api-key: [Required] Partner specific API key provided by Birdeye for data exchange.
            x-business-number: [Required] User assosiated businessNumber

    + Attributes

        + id: 115339282 (string) - Id of enterprise customer. optional (if cid, phone or email is provided).
        + cid: 293847172 (string) - Id of customer mapping on a location. optional (if id, phone or email is provided).
        + email: ron@test.con (string) - Email of customer, optional (if phone, id or cid is provided).
        + phone: 123 456 7890 (string) - Phone of customer optional (if email, id or cid is provided).


    + Body

            {
                "id": 115339282,
                "cid": 293847172,
                "email": "test.user@test.com",
                "phone": "(212) xxx-xxxx"
            }

+ Response 200 (application/json)

    + Attributes


        + id: 115339282 (string) - Id of enterprise customer.
        + firstName: Ron (string) - First name of the customer.
        + lastName: Spector (string) - Last name of the customer.
        + email: ron@test.con (string) - Email of customer, optional (if phone is provided).
        + phone: 123 456 7890 (string) - Phone of customer optional (if email is provided).
        + countryCode: US (string) - Country code of the phone number. Default value=US, Other Possible values=AU,CA,MX,PR,VI
        + smsOptin: false (boolean) - SMS Opting flag.
        + mappings (array) - List of locations where customer is mapped. If requested by cid, only that location's mapping is returned.
            + (object)
                + cid: 12345 (number) - Customer location id.
                + location: New York (string) - Name of the location.
                + bid: 710687 (number) - Location id.
                + businessNumber: 169744180007807 (number) - Location Number.
        + tags: Tag One, Tag Two (string) - List of tags.
        + customFields (array) - List of Custom fields.
            + (object)
                + fieldName: Company (string) - Field name.
                + type: text (string) - Field type.
                + fieldValue: Dunder Mifflin (string) - Value of field.
        + externalId: ABC123 (string) - Unique external identifier of the contact which could be from the CRM or any external system storing your contacts.
        + emailPreferences (object) - Email communication preference flags.
            + marketingOptin: true (boolean) - Marketing communication.
            + feedbackOptin: true (boolean) - Feedback communication.
            + serviceOptin: true (boolean) - Service communication.
        + smsPreferences (object) - SMS communication preference flags.
            + marketingOptin: true (boolean) - Marketing communication.
            + feedbackOptin: true (boolean) - Feedback communication.
            + serviceOptin: true (boolean) - Service communication.


    + Body

            {
                "id": 115339282,
                "firstName": "Michael",
                "lastName": "Scott",
                "email": "test.user@test.com",
                "phone": "(212) xxx-xxxx",
                "countryCode": "US",
                "blocked": false,
                "smsOptin": true,
                "source": "api",
                "created": "January 12, 2021",
                "mappings": [
                {
                    "cid": 1234451,
                    "location": "new horizon",
                    "bid": 710687,
                    "businessNumber": 161458406365307
                },
                {
                    "cid": 1235452,
                    "location": "North Carolina",
                    "bid": 714169,
                    "businessNumber": 161072537475129
                }],
                "tags": ["Tag One","Tag Two"],
                "customFields": [
                {
                    "fieldName": "Company",
                    "type": "text",
                    "fieldValue": "Dunder Mifflin"
                },
                {
                    "fieldName": "Product",
                    "type": "text",
                    "fieldValue": "Paper"
                }],
                "externalId": "ABC123",
                "emailPreferences": {
                    "marketingOptin": true,
                    "feedbackOptin": true,
                    "serviceOptin": true
                },
                "smsPreferences": {
                    "marketingOptin": true,
                    "feedbackOptin": true,
                    "serviceOptin": true
                }
            }

+ Response 401

    [1161][]

+ Response 429

    [89][]

+ Response 400

    [1167][]

+ Response 404

    [1532][]

+ Response 400

    [5043][]


## Customer Check in [/v1/contact/external/preferences/checkin]
Customer check-in can be done using Check in API.


### Customer Checkin [POST]



+ Request (application/json)

    + Headers

            Accept: application/json
            x-api-key: [Required] Partner specific API key provided by Birdeye for data exchange.
            x-business-number: [Required] User assosiated businessNumber

    + Attributes
        + name: Steve Smith  (string) - Name of the customer.
        + emailId: steves@abcd.com (string) - Email ID of the customer (optional If business has enabled for sms, then either email or phone will be required).
        + phone: 4081231234 (string) - Phone number of the customer (optional If business has enabled for sms, then either email or phone will be required).
        + smsEnabled: 0 (number) - Whether customer has opted to receive SMS request or not. Valid values are 0(false), 1(true). Default is 1.
        + additionalParams (object) - Custom tags can be added as key value pair.
        + employees (array)
            + (object)
                + emailId: sshikha@abcd.com (string) - Email Id of assisted Employee.
        + externalId: ABC123 (string) - Unique external identifier of the contact which could be from the CRM or any external system storing your contacts.
        + emailPreferences (object) - Email communication preference flags.
            + marketingOptin: true (boolean) - Marketing communication.
            + feedbackOptin: true (boolean) - Feedback communication.
            + serviceOptin: true (boolean) - Service communication.
        + smsPreferences (object) - SMS communication preference flags.
            + marketingOptin: true (boolean) - Marketing communication.
            + feedbackOptin: true (boolean) - Feedback communication.
            + serviceOptin: true (boolean) - Service communication.

    + Body

            {
              "name": "Steve Smith",
              "emailId": "steves@abcd.com",
              "phone": "408-xxx-xxxx",
              "smsEnabled": 1,
              "additionalParams" :
               {
                    "Tag Group Name 1": "Tag Name 1",
                    "Tag Group Name 2" :"Tag Name 2",
                    "location" :"New York"
               },
              "employees":[{
                             "emailId" : "sshikha@abcd.com"
                          }],
              "externalId": "ABC123",
                "emailPreferences": {
                    "marketingOptin": true,
                    "feedbackOptin": true,
                    "serviceOptin": true
                },
                "smsPreferences": {
                    "marketingOptin": true,
                    "feedbackOptin": true,
                    "serviceOptin": true
                }
            }

+ Response 200 (application/json)

    + Attributes
        + customerId: 673356544  (number) - Id of enterprise customer.


    + Body

            {
                "customerId":”673356544”
            }

+ Response 400 (application/json)

    + Body

            {
                "code": 20099,
                "message": "Text Communication categorisation is not enabled please use smsOptin flag"
            }


+ Response 400

    [1142][]

+ Response 400

    [1086][]

+ Response 400

    [1087][]


+ Response 400

    [1088][]


+ Response 400

    [1055][]


+ Response 400

    [1170][]

+ Response 401

    [1033][]

+ Response 401

    [1161][]

+ Response 429

    [89][]

+ Response 401

    [1167][]

+ Response 401

    [1175][]

## Update Communication Preferences [/v1/contact/external/preferences/change-permission]
Customer can be subscribe/unsubscribe from Email & SMS using this API.


### Update Communication Preferences [POST]



+ Request (application/json)

    + Headers

            Accept: application/json
            x-api-key: [Required] Partner specific API key provided by Birdeye for data exchange.
            x-business-number: [Required] User assosiated businessNumber

    + Attributes
        + emailPreferences (object) - Email communication preference flags.
            + marketingOptin: true (boolean) - Marketing communication.
            + feedbackOptin: true (boolean) - Feedback communication.
            + serviceOptin: true (boolean) - Service communication.
        + smsPreferences (object) - SMS communication preference flags.
            + marketingOptin: true (boolean) - Marketing communication.
            + feedbackOptin: true (boolean) - Feedback communication.
            + serviceOptin: true (boolean) - Service communication.
        + smsOptin: true (boolean) - SMS communication.
        + email: test1@mail.in, ron@test.com (array) - Customer email ids.
        + phone: 2345654326, 1234567890 (array) - Customer phone numbers.
        + accountNumber: 123456789876543 (number, required) - Location id.

    + Body

            {
                "emailPreferences": {
                    "marketingOptin": true,
                    "feedbackOptin": true,
                    "serviceOptin": true
                },
                "smsPreferences": {
                    "marketingOptin": true,
                    "feedbackOptin": true,
                    "serviceOptin": true
                },
                "smsOptin": true
                "email": ["test1@mail.in"],
                "phone": ["2345654326"],
                "accountNumber":123456789876543
            }

+ Response 200 (application/json)


    + Body

            true or false


+ Response 404

    [1011][]

+ Response 401

    [1161][]

+ Response 429

    [89][]

+ Response 401

    [1167][]


+ Response 400

    [1089][]

## Retrieve Opted-Out Contacts [/v1/contact/external/preferences/update-feed]
API to fetch the daily opt-out or blocked contact data for a business

### Retrieve Opted-Out Contacts [POST]



+ Request (application/json)

    + Headers

            Accept: application/json
            x-api-key: [Required] Partner specific API key provided by Birdeye for data exchange.
            x-business-number: [Required] User assosiated businessNumber


    + Attributes
        + start: 1693570640000 (number, required) - The start date format should be in milliseconds. If the start date is not set and the end date is provided, we will fetch data for 24 hours before the end date. If both are not provided, the latest 24 hours data will be fetched.
        + end: 1693657040000 (number,required) -  The end date format should be in milliseconds. If the end date is not set and the start date is provided, we will fetch data for 24 hours after the start date. If both are not provided, the latest 24 hours data will be fetched.
        + subscriptionStatus: 155911947195757, 155290409184734 (array,required) - Type of subscription update feed we want the data for. Like opted-out to get email and text optouts, and blocked for contacts getting blocked. If not provided, only opted-out updates will be returned, by default.




    + Body

            {
                "end": 1693657040000,
                "start": 1693570640000,
                "subscriptionStatus": [ "blocked","opted-out" ]
            }

+ Response 200 (application/json)


    + Attributes

        + emailOptOut (array) - All the contacts grouped under this field, which were opted out from email in the given duration
            + (object)
                + id: 1213422 (number) - id of the enterprise customer.
                + firstName: John (string) - First name of the contact.
                + lastName: Doe (string) - Last name of the contact.
                + emailId: john@yahoo.com (string) - EmailId of the contact, if exists.
                + phone (string) - Phone number of the contact, if exists. Format is (xxx) xxx-xxxx.
                + optOutFrom (array[string]) - Categories from which the contact has opted out (e.g., marketing, feedback, service).
        + textOptOut (array) - All the contacts grouped under this field, which were opted out from text in the given duration
            + (object)
                + id: 1213422 (number) - id of the enterprise customer.
                + firstName: John (string) - First name of the contact.
                + lastName: Doe (string) - Last name of the contact.
                + emailId: john@yahoo.com (string) - EmailId of the contact, if exists.
                + phone (string) - Phone number of the contact, if exists. Format is (xxx) xxx-xxxx.
                + optOutFrom (array[string]) - Categories from which the contact has opted out (e.g., marketing, feedback, service).
        + blocked (array) - All the contacts grouped under this field, which were blockedl in the given duration.
            + (object)
                + id: 1213422 (number) - id of the enterprise customer.
                + firstName: John (string) - First name of the contact.
                + lastName: Doe (string) - Last name of the contact.
                + emailId: john@yahoo.com (string) - EmailId of the contact, if exists.
                + phone (string) - Phone number of the contact, if exists. Format is (xxx) xxx-xxxx.
                + optOutFrom (array[string]) - Categories from which the contact has opted out (e.g., marketing, feedback, service).


    + Body

            {
              "emailOptOut": [
                {
                  "id": 1213422,
                  "firstName": "John",
                  "lastName": "Doe",
                  "emailId": "john@yahoo.com",
                  "phone": "(212) 234-1242",
                  "optOutFrom": ["marketing", "feedback"]
                },
                {
                  "id": 1213423,
                  "firstName": "Johnny",
                  "lastName": "Doe",
                  "emailId": "johnny@yahoo.com",
                  "phone": "(212) 231-1242",
                  "optOutFrom": ["marketing", "feedback"]
                }
              ],
              "textOptOut": [
                {
                  "id": 1213425,
                  "firstName": "Jane",
                  "lastName": "Doe",
                  "emailId": "john@yahoo.com",
                  "phone": "(212) 234-1242",
                  "optOutFrom": ["marketing", "feedback"]
                },
                {
                  "id": 1213423,
                  "firstName": "Johnny",
                  "lastName": "Doe",
                  "emailId": "johnny@yahoo.com",
                  "phone": "(212) 231-1242",
                  "optOutFrom": ["marketing", "feedback"]
                }
              ],
              "blocked": [
                {
                  "id": 1213422,
                  "firstName": "John",
                  "lastName": "Doe",
                  "emailId": "john@yahoo.com",
                  "phone": "(212) 234-1242",
                  "optOutFrom": ["marketing", "feedback"]
                },
                {
                  "id": 1213423,
                  "firstName": "Johnny",
                  "lastName": "Doe",
                  "emailId": "johnny@yahoo.com",
                  "phone": "(212) 231-1242",
                  "optOutFrom": ["marketing", "feedback"]
                }
              ]
            }


+ Response 401

    [1161][]

+ Response 401

    [1011][]

+ Response 429

    [89][]

+ Response 400

    [20083][]



# Group Campaign
Create a short link for review requests and set review sources in the template.

## Fetch Request URL [/v1/campaign/external/campaign-request-url]
Fetch Request URL gets the short link of the requested URL for the customer.

### Fetch Request URL [POST]


+ Request (application/json)

    + Headers

            Accept: application/json
            x-api-key: [Required] Partner specific API key provided by Birdeye for data exchange.

    + Attributes
        + businessId: 100018055 (number, required) - Id of a business (Long).
        + customerId (number,required) - Id of the Customer.
        + surveyId: 6102 (number) - Survey Id, required only for survey requests.
        + templateId: 1133204 (number) - Id of Text template, required except for survey requests.
        + checkinId: 123456 (number) - Checkin id of customer.


    + Body

            {
                "businessId": "100018055",
                "customerId": 39870987,
                "surveyId":6102,
                "templateId": 1133204,
                "checkinId": 123456
            }

+ Response 200 (application/json)

    + Attributes
        + externalUId: 10001805512 (number) - Id of the requested URL.
        + url (number) - Short link of the requested URL.


    + Body

            {
                "externalUId" : 10001805512,
                "url" : "https://birdeye.cx/a1swor"
            }

+ Response 401

    [1161][]

+ Response 401

    [1011][]

+ Response 400

    [1089][]

+ Response 400

    [1040][]

+ Response 400

    [1315][]

+ Response 429

    [89][]




## Set Defaullt Review Sources [/v1/campaign/external/default-review-sources]
Set Default Review Sources API updates default templates of businesses under a reseller with default review sources (i.e., Google/Facebook).

### Set Defaullt Review Sources [POST]


+ Request (application/json)

    + Headers

            Accept: application/json
            x-api-key: [Required] Partner specific API key provided by Birdeye for data exchange.

    + Attributes
        + businessId: 157189662556139 (number, required) - Id of reseller (Long).
        + customerId: 155911947195757, 155290409184734 (array,required) - List of business ids under a reseller.


    + Body

            {
                "resellerId": “157189662556139”,
                "businessIds": [ 155911947195757, 155290409184734 ]
            }

+ Response 200 (application/json)



+ Response 401

    [1161][]

+ Response 401

    [1011][]

+ Response 429

    [89][]

# Group Aggregation

Access your public data from 150+ review sites.

## Get source list [/v1/aggregation/business/{businessId}]
Get source list API returns the list of aggregations associated with the location/SMB.


### Get all aggregation source [GET]

+ Parameters

    + businessId: 12345678 (string, required) - Id of the Business.


+ Request (application/json)

    + Headers

            Accept: application/json
            x-api-key: [Required] Partner specific API key provided by Birdeye for data exchange.

+ Response 200 (application/json)

    + Attributes (array)
        + (object)
            + id: 234950761 (number) - Id of aggregation.
            + sourceAlias: citysearch (string) - Source alias.
            + sourceUrl: http://www.citysearch.com/biz/trattoria-da-vittorio-san-francisco (string) - Source url.
            + sourceName: Citysearch (string) - Source name.



    + Body

            {[
                {
                    "id": "234970154",
                    "sourceAlias": "our_website",
                    "sourceUrl": "http://birdeye.com/trattoria-da-vittorio-943999808/recommendus",
                    "sourceName": "Our Website"
                },
                {
                    "id": "234950761",
                    "sourceAlias": "citysearch",
                    "sourceUrl": "http://www.citysearch.com/biz/trattoria-da-vittorio-san-francisco",
                    "sourceName": "Citysearch"
                },
                {
                    "id": "235020762",
                    "sourceAlias": "google",
                    "sourceUrl": "https://plus.google.com/112610500708977805079/about?gl=US&hl=en-US",
                    "sourceName": "Google"
                }
            ]}


+ Response 401

    [1161][]

+ Response 429

    [89][]

+ Response 401

    [1167][]

+ Response 401

    [1033][]

+ Response 404

    [1175][]


## Get Source List-lite [/v1/survey/reviewsites-alias{?businessId}]
Get Source List-lite returns a list of aggregation aliases associated with the location/SMB.

### Get all aggregation source [GET]


+ Parameters

    + businessId: 12345678 (string, required) - Id of the business.


+ Request (application/json)

    + Headers

            Accept: application/json
            x-api-key: [Required] Partner specific API key provided by Birdeye for data exchange.

+ Response 200 (application/json)


    + Attributes (object)
        + aliases: Google,Citysearch,Yellow Pages (array) - List of source aliases.


    + Body

            {
                "aliases": [
                    "Google",
                    "Citysearch",
                    "Yahoo! Local",
                    "Yellow Pages",
                    "Insider Pages",
                    "Superpages",
                    "Amazon",
                    "Facebook",
                    "Realself",
                    "ConsumersAdvocate",
                    "Vrbo",
                    "Tell Management",
                    "Rehabs.com"
                ]
            }

+ Response 401

    [1161][]

+ Response 429

    [89][]

+ Response 401

    [1167][]

+ Response 401

    [1033][]

+ Response 404

    [1175][]


## Add Aggregation Link [/v1/aggregation/business/{business_id}]
Add Aggregation Link adds the aggregation URL to the location.

### Add aggregation URL [POST]

+ Parameters

    + business_id: 12345678 (string, required) - Id of the business.

+ Request (application/json)

    + Headers

            Accept: application/json
            x-api-key: [Required] Partner specific API key provided by Birdeye for data exchange.

    + Attributes
        + sourceAlias: citysearch (string, required) - Source alias.
        + url: http://www.citysearch.com/biz/maria-da-vittorio-san-francisco (string, required) - Source url to be added.


    + Body

            {
                "sourceAlias" : "citysearch ",
                "url" : "http://www.citysearch.com/biz/maria-da-vittorio-san-francisco"
            }


+ Response 200 (application/json)

    + Attributes
        + id: 237030543 (number) - Id of the created Aggregation.
        + sourceAlias: citysearch (string) - Alias of the source.
        + sourceName: Citysearch (string) - Name of the source.
        + sourceUrl: http://www.citysearch.com/biz/maria-da-vittorio-san-francisco (string) - Url of the souce.



     + Body

            {
                "id": "237030543",
                "sourceAlias": "citysearch",
                "sourceName": "Citysearch",
                "sourceUrl": "http://www.citysearch.com/biz/maria-da-vittorio-san-francisco"
            }

+ Response 404

    [1011][]

+ Response 401

    [1167][]

+ Response 401

    [1161][]

+ Response 429

    [89][]

+ Response 400

    [1030][]

+ Response 400

    [1031][]

+ Response 400

    [1032][]



## Delete [/v1/aggregation/business/{businessID}/aggregation/{aggregationID}]
Delete Aggregation API deletes aggregation from the location/SMB.


### Delete aggregation URL [DELETE]

+ Parameters

    + businessID: 12345678 (string, required) - Id of the business.
    + aggregationID: abcdefgh (number, required) - Id of the aggregation to be deleted.


+ Request (application/json)

    + Headers

            Accept: application/json
            x-api-key: [Required] Partner specific API key provided by Birdeye for data exchange.

+ Response 200 (application/json)


+ Response 404

    [1011][]

+ Response 401

    [1167][]

+ Response 401

    [1161][]

+ Response 429

    [89][]

+ Response 400

    [1039][]


# Group Report
Various reporting data points across Birdeye modules like reviews, insights and competitors etc for all your data visualisation

## Dashboard [/v1/reports/smb{?bid}]
Get Dashboard Data API gives you an overview of business data with data points like review & rating count, sentiment of reviews, negative/positive reviews, and past 30 days' reviews with review responses.

### Get Dashboard data [GET]

+ Parameters

    + bid: 12345678 (string, required) - Id of the Business.


+ Request (application/json)

    + Headers

            Accept: application/json
            x-api-key: [Required] Partner specific API key provided by Birdeye for data exchange.


+ Response 200 (application/json)

    + Body

            {
                "allTime": {
                "avgRating": {
                    "percentChange": 0,
                    "rating": 4.3
                },
                "benchmark": {
                    "industryRating": 4.1,
                    "industryReviewCount": 75785,
                    "percentChange": 4,
                    "rating": 4.3
                },
                "custCommn": {},
                "reviewCount": {
                    "count": 376,
                    "percentChange": 0
                },
                "sentiments": {
                    "negative": 45,
                    "neutral": 36,
                    "positive": 295
                },
                "visitors": {}
            },
            "last30Days": {
                "avgRating": {
                    "rating": 0
                },
                "benchmark": {
                "industryRating": 0,
                "industryReviewCount": 0,
                "percentChange": 0,
                "rating": 0
            },
            "custCommn": {
                "reviewRequest": 0,
                "reviewRequestSms": 0,
                "shareReview": 0
            },
            "reviewCount": {
                "count": 0,
                "percentChange": 0
            },
            "sentiments": {
                "negative": 0,
                "neutral": 0,
                "positive": 0
            },
            "visitors": {}
            },
            "negativeReviews": [
            {
                "comments": "One word...inconsistent. We had high hopes for this place but alas it was not to be. While the servers were polite, they lacked the professionalism normally expected at most dining establishments...you know, simple things like the waiter introducing himself by name or dropping by to see how we liked the food or refilling our drinks. The minestrone soup was pretty good but the fried calamari was bland, rubbery, obviously over cooked, and did I mention bland. The linguini pescatora was also inconsistent. The pasta in the dish was excellent but the calamari was once again over cooked and rubbery, I got a couple of clams that were not cleaned resulting in a few mouthfuls of dirt, and the shrimp was once again over cooked. We also ordered the margherita pizza with mushrooms and that was pretty good. Overall, we cannot recommend this place.",
                "rating": 1,
                "response": "",
                "reviewDate": "Jan 30, 2015",
                "reviewId": "2335311245464",
                "reviewUrl": "http://www.citysearch.com/biz/maria-da-vittorio-san-francisco?hrid=60fLFX4lRvHnodkhoWC2lw&nb=1",
                "reviewer": {
                    "city": "Yorba Linda",
                    "nickName": "wendy w.",
                    "state": "CA",
                    "thumbnailUrl": "http://d2xt3xymj142xp.cloudfront.net/reviewer/9a070cf98f014f5d9b06987dcc9c48fe.jpeg"
                },
                "sourceType": "citysearch"
            },
            {
                "comments": "Veal Scaloppini, mushrooms, marsala wine, seasonal vegetables and potatoes $24.\nFlavor was great but disappointed in portion 2 small thin slice, I had better portion in North Beach...my shoe sole was large than this portion. I'm petite size woman; still left hungry....not a hungry man plate. Don't waste your money on this one, men.",
                "rating": 2,
                "response": "",
                "reviewDate": "Jan 26, 2015",
                "reviewId": "2335208845791",
                "reviewUrl": "http://www.citysearch.com/biz/maria-da-vittorio-san-francisco?hrid=FKcQE7naP_Wb4D2ylDsLaQ&nb=1",
                "reviewer": {
                    "city": "San Francisco",
                    "nickName": "Catalina W.",
                    "state": "CA",
                    "thumbnailUrl": "http://d2xt3xymj142xp.cloudfront.net/reviewer/9a070cf98f014f5d9b06987dcc9c48fe.jpeg"
                },
                "sourceType": "citysearch"
            },
            {
                "comments": "I have to say that this restaurant is very nice but very Loud!:( The bread was old:( The prosciutto appetizer was ridiculous! They only used one slice on six slices of bread:( My husband's main course of the Veal Scallopini was a complete shame! Great sauce but come on! 4 very thin slices of veal w/veggies & red potatoes, he was starving when we got home!:( At $24!!! Ridiculously stingy! My lamb shank & mashed potatoes was superb! No veggies though:( $19 We won't be returning, I was not impressed, I'd rather go to North Beach w/ real Italian dining:) they do have good food but they need to step it up a notch for the prices they charge, I hope they read they're review's so they can change things, Good luck",
                "rating": 2,
                "response": "",
                "reviewDate": "Jan 26, 2015",
                "reviewId": "2337522245554",
                "reviewUrl": "http://www.citysearch.com/biz/maria-da-vittorio-san-francisco?hrid=Xn9XOjZYNknHQu5eF9MteQ&nb=1",
                "reviewer": {
                    "city": "San Francisco",
                    "nickName": "Adele R.",
                    "state": "CA"
                },
                "sourceType": "citysearch"
            }
            ],
            "positiveReviews": [
            {
                "comments": "Service is awesome- everyone is from Italy and are so sweet and low the menu/specials from head to toe. Great wine selection that's pretty reasonable. The Bruschetta varieties are unique and yummy. Sometimes main dishes can be hit or miss-not very consistent but it's a new restaurant that I can see establish itself a few great dishes overtime.",
                "rating": 4,
                "response": "",
                "reviewDate": "Jan 23, 2015",
                "reviewId": "2334445645625",
                "reviewUrl": "http://www.citysearch.com/biz/maria-da-vittorio-san-francisco?hrid=YYtOE3hvBjp4jYtLgtgBoQ&nb=1",
                "reviewer": {
                    "city": "San Francisco",
                    "nickName": "Anastasia P.",
                    "state": "CA",
                    "thumbnailUrl": "http://d2xt3xymj142xp.cloudfront.net/reviewer/9a070cf98f014f5d9b06987dcc9c48fe.jpeg"
                },
                "sourceType": "citysearch"
            },
            {
                "comments": "I've been here 3 times in the past year, & it's been good every time.",
                "rating": 4,
                "response": "",
                "reviewDate": "Jan 23, 2015",
                "reviewId": "2333514245697",
                "reviewUrl": "http://www.citysearch.com/biz/maria-da-vittorio-san-francisco?hrid=3kiZtC-tj-FGLO3GPRqNDA&nb=1",
                "reviewer": {
                    "city": "Daly City",
                    "nickName": "Matt L.",
                    "state": "CA"
                },
                "sourceType": "Citysearch"
            },
            {
                "comments": "Owner is awesome! ! Came here tonight with my parents and sister's family. .highly recommended! ! I will definitely come back here again!",
                "rating": 5,
                "response": "",
                "reviewDate": "Jan 21, 2015",
                "reviewId": "2336865297689",
                "reviewUrl": "http://www.citysearch.com/biz/maria-da-vittorio-san-francisco?hrid=U8mRtt5vA93l0n7j2H1J_w&nb=1",
                "reviewer": {
                    "city": "San Francisco",
                    "nickName": "Johnny C.",
                    "state": "CA",
                    "thumbnailUrl": "http://d2xt3xymj142xp.cloudfront.net/reviewer/9a070cf98f014f5d9b06987dcc9c48fe.jpeg"
                },
                "sourceType": "Citysearch"
            }
            ],
            "syndication": {
            "presenceCount": 0,
            "reviewDistribution": [
                {
                    "count": 328,
                    "name": "citysearch"
                },
                {
                    "count": 8,
                    "name": "Google"
                },
                {
                    "count": 1,
                    "name": "Yellow Pages"
                },
                {
                    "count": 16,
                    "name": "Foursquare"
                },
                {
                    "count": 23,
                    "name": "Facebook"
                }
            ],
            "reviewListings": [
                {
                    "id": 2,
                    "name": "Google",
                    "url": "https://plus.google.com/112610500708977805079/about?gl=US&hl=en-US"
                },
                {
                    "id": 3,
                    "name": "Citysearch",
                    "url": "http://www.citysearch.com/biz/maria-da-vittorio-san-francisco"
                },
                {
                    "id": 4,
                    "name": "Yahoo! Local",
                    "url": "https://local.yahoo.com/info-148859369-maria-da-vittorio-san-francisco"
                },
                {
                    "id": 5,
                    "name": "Yellow Pages",
                    "url": "http://www.yellowpages.com/san-francisco-ca/mip/maria-da-vittorio-478366944"
                },
                {
                    "id": 10,
                    "name": "Foursquare",
                    "url": "https://foursquare.com/v/maria-da-vittorio/5195394d498e344eeb952b4f"
                },
                {
                    "id": 16,
                    "name": "Superpages",
                    "url": "http://www.superpages.com/bp/San-Francisco-CA/maria-Da-Vittorio-L2450131113.htm"
                },
                {
                    "id": 33,
                    "name": "Merchant Circle",
                    "url": "http://www.merchantcircle.com/business/maria.Da.Vittorio.415-592-8398"
                },
                {
                    "id": 63,
                    "name": "YellowBot",
                    "url": "http://www.yellowbot.com/maria-da-vittorio-san-francisco-ca.html"
                },
                {
                    "id": 84,
                    "name": "MapQuest",
                    "url": "http://www.mapquest.com/us/california/italian-restaurants-san-francisco/maria-da-vittorio-284984723"
                },
                {
                    "id": 110,
                    "name": "Facebook",
                    "url": "https://www.facebook.com/mariadavittorio"
                }
            ]}
            }


+ Response 404

    [1011][]

+ Response 401

    [1167][]

+ Response 401

    [1161][]

+ Response 429

    [89][]


## Review conversion report [/v1/reports/business/analytics/email{?businessId,fromDate,toDate,days,months}]
Review conversion report API gives you the detail overview of the review request send to the customer.

### Get Review conversion report [GET]

+ Parameters
    + businessId: 12345678 (number, required) - Id of the Business.
    + fromDate: 01/13/2021 (string, optional) - Date from result is expected. Format MM/DD/YYYY.
    + toDate: 01/21/2021 (string, optional) - Date up to result is expected. Format MM/DD/YYYY.
    + days: 120 (number, optional) - Use to get results for last some days.
    + months: 2 (number, optional) - Use to get results for last some months.


+ Request (application/json)

    + Headers

            Accept: application/json
            x-api-key: [Required] Partner specific API key provided by Birdeye for data exchange.


+ Response 200 (application/json)

    + Attributes
        + emailSentInfo (object) - Email sent details.
            + total: 12 (number) - Total number of email send.
            + emailDetails (array) - Details of email.
                + (object)
                    + reqType: share_request (string) - Type of request, Values could be share_request, share_request_reminder,review_request,review_request_reminder.
                    + count: 120 (number) - Number of request send.
        + emailOpenInfo (object) - Email open details.
            + total: 50 (number) - Total number of email opened.
            + pc: 20 (number) - Total number of email opened on PC.
            + mobile (object) - Total number of email opened on Mobile device.
                + ios: 5 (number) - IOS
                + android: 5 (number) - Anroid
                + other: 5 (number) - Others
            + tablet (object) - Total number of email opened on Tablet device.
                + ios: 5 (number) - IOS
                + android: 5 (number) - Anroid
                + other: 5 (number) - Others
        + emailClickInfo (array) - Email click details.
            + (object)
                + total: 12 (number) - Total number of email clicked.
                + pc (array) - Total number of email clicked on PC.
                    + (object)
                        + citysearch: 5 (number) - Email click on citysearch.
                        + google: 5 (number) - Email click on google.
                        + birdeye: 5 (number) - Email click on birdeye.
                        + otherSites: 5 (number) - Email click on otherSites.
        + reviews (array) - Review details
            + (object)
                + sourceName: Citysearch (string) - Source name
                + sourceAlias: citysearch (string) - Souce alias
                + avgRating: 4.0 (number) - Average rating
                + reviewCount: 12 (number) -  Review count
        + smsDetail (object) - SMS details.
            + msgSent: 20 (number) - Total number of SMS sent.
            + msgClick: 20 (number) - Total number of SMS clicked.
            + destination (array) -
                + (object)
                    + citysearch: 6 (number) - Number of click on citysearch.
                    + google: 5 (number) - Number of click on google.
                    + birdeye: 7 (number) - Number of click on birdeye.
                    + otherSites: 6 (number) - Number of click on otherSites.

    + Body

            {
                "emailSentInfo": {
                    "total": 28,
                    "emailDetails": [{
                        "reqType": "share_request",
                        "count": 5
                    },
                    {
                        "reqType": "share_request_reminder",
                        "count": 3
                    },
                    {
                        "reqType": "review_request",
                        "count": 12
                    },
                    {
                        "reqType": "review_request_reminder",
                        "count": 10
                    }]
                },
                "emailOpenInfo": {
                    "total": 26,
                    "pc": 14,
                    "mobile": {
                        "ios": 5,
                        "android": 4,
                        "other": 0
                    },
                    "tablet": {
                        "ios": 3,
                        "android": 0,
                        "other": 0
                    }
                },
                "emailClickInfo": {
                    "total": 20,
                    "pc": {
                        "citysearch": 4,
                        "google": 6,
                        "birdeye": 4,
                        "otherSites": 0
                    },
                    "mobile": {
                        "citysearch": 2,
                        "google": 0,
                        "birdeye": 4,
                        "otherSites": 0
                    }
                },
                "reviews": [{
                    "sourceName": "citysearch",
                    "sourceAlias": "citysearch",
                    "avgRating": 4.6,
                    "reviewCount": 159
                },
                {
                    "sourceName": "Google",
                    "sourceAlias": "google",
                    "avgRating": 4.9,
                    "reviewCount": 8
                },
                {
                    "sourceName": "Yellow Pages",
                    "sourceAlias": "yellow_pages",
                    "avgRating": 5,
                    "reviewCount": 1
                }],
                "smsDetail": {
                    "msgSent": 34,
                    "msgClick": 28,
                    "destination": {
                        "citysearch": 12,
                        "google": 6,
                        "birdeye": 10,
                        "otherSites": 0
                    }
                }
            }




+ Response 404

    [1011][]

+ Response 401

    [1167][]

+ Response 401

    [1161][]

+ Response 429

    [89][]

+ Response 400

    [1039][]



## Review and rating over time [/v1/reports/review/analytic/time{?businessId,sortby,sorder}]
Review and rating over time API gives you the number of reviews and average rating in accordance with the time.

### Review and rating over time Report [POST]


+ Parameters
    + businessId: 12345678 (number, required) - Id of the Business.
    + sortby: rating (string, optional) - Values can be 'count' or 'rating'.
    + sorder: 0 (number, optional) - '0' for ascending and '1' for descending order.

+ Request (application/json)

    + Headers

            Accept: application/json
            x-api-key: [Required] Partner specific API key provided by Birdeye for data exchange.

    + Attributes
        + sourceAliases: citysearch,google (array) - List of source aliases.
        + businessNumbers: 943967608,943476803 (array) - List of business number.
        + days: 12 (number) - Use to get results for last some days.

    + Body

            {
                "sourceAliases": ["citysearch ", "google"],
                "businessNumbers": ["943967608", "943476803"],
                "days": 12
            }


+ Response 200 (application/json)

    + Attributes (array)
        + (object)
            + rating: 2.0 (number) - Average Rating for the particular day.
            + count: 10 (number) - Number of reviews for the particular day.
            + milestone: 8/20/15 (string) - Date.


    + Body

            [{
                "rating": 0.0,
                "count": 0,
                "milestone": "8\/19\/15",
            },
            {
                "rating": 3.9,
                "count": 23,
                "milestone": "8\/20\/15",
            },
            {
                "rating": 4.9,
                "count": 55,
                "milestone": "8\/21\/15",
            },
            {
                "rating": 2.9,
                "count": 24,
                "milestone": "8\/22\/15",
            },
            {
                "rating": 2.6,
                "count": 23,
                "milestone": "8\/23\/15",
            },
            {
                "rating": 3.3,
                "count": 45,
                "milestone": "8\/24\/15",
            },
            {
                "rating": 1.6,
                "count": 28,
                "milestone": "8\/25\/15",
            }]


+ Response 404

    [1011][]

+ Response 401

    [1167][]

+ Response 401

    [1161][]

+ Response 429

    [89][]



## Reviews & Rating By Location [/v1/reports/rating/location{?businessId,sortby,sorder}]
Reviews & Rating By Location gives an overall view of how many reviews, and the average ratings are associated with each location.


### Reviews & Rating By Location Report [POST]



+ Parameters
    + businessId: 12345678 (number, required) - Id of the Business.
    + sortby: rating (string, optional) - Values can be 'count' or 'rating'.
    + sorder: 0 (number, optional) - '0' for ascending and '1' for descending order.


+ Request (application/json)

    + Headers

            Accept: application/json
            x-api-key: [Required] Partner specific API key provided by Birdeye for data exchange.

    + Attributes
        + sourceAliases: citysearch,google (array) - List of source aliases.
        + businessNumbers: 943967608,943476803 (array) - List of business number.
        + months: 12 (number) - Use to get results for last some months.

    + Body

            {
                "sourceAliases": ["citysearch ", "google"],
                "businessNumbers": ["943967608", "943476803"],
                "months": 12
            }


+ Response 200 (application/json)

    + Attributes

        + rating: 2.0 (number) - Average Rating for the particular location.
        + count: 10 (number) - Number of reviews for the particular location.
        + milestone: Smile dental (string) - Name of the Location.
        + businessId: 943967608 (number) - Business number of the location.
        + state: CA (string) - State.


    + Body

            [{
                "rating": 4.6,
                "count": 132,
                "milestone": "Smile dental",
                "businessId": 943967608,
                "state": "CA"
            },
            {
                "rating": 3.2,
                "count": 367,
                "milestone": "Blaze Dental",
                "businessId": 943589678,
                "state": "CA"
            }]


+ Response 404

    [1011][]

+ Response 401

    [1167][]

+ Response 401

    [1161][]

+ Response 429

    [89][]





## Review Count & Rating [/v1/review/report/count-by-rating/{BusinessId}]
Review Count & Rating API fetches the review count according to the rating.

### Review Count & Rating [POST]

+ Parameters

    + BusinessId: 12345678 (string, required) - Id of the business.

+ Request (application/json)

    + Headers

            Accept: application/json
            x-api-key: [Required] Partner specific API key provided by Birdeye for data exchange.

    + Attributes

        + businessNumbers: 145308764185002,145308769721320 (array) - Business Numbers under enterprise account.
        + sourceAlias: google (string) - Alias of the source.
        + fromDate: 04/01/2013 (string) - Review date (start).
        + toDate: 04/01/2013 (string) - Review date (end).



    + Body

            {
                "businessNumbers": [145308764185002,145308769721320],
                "sourceAlias": ["google","citysearch"],
                "fromDate": "04/01/2013",
                "toDate": "05/3/2015"
            }

+ Response 200 (application/json)

    + Attributes

        + reviewCount: 220 (number) - Total number of reviews.
        + countByRating (array) - Review count against each possible review rating. For Facebook recommended and non-recommended reviews rating will be 0.
            + (object)
                + rating: 5 (number) -  Review Rating.
                + count: 140 (number) -  Number of reviews according to rating.


    + Body

            {
                "reviewCount": 108,
                "countByRating": [
                    {
                        "rating": 0,
                        "count": 17
                    },
                    {
                        "rating": 1,
                        "count": 19
                    },
                    {
                        "rating": 2,
                        "count": 3
                    },
                    {
                        "rating": 3,
                        "count": 14
                    },
                    {
                        "rating": 4,
                        "count": 11
                    },
                    {
                        "rating": 5,
                        "count": 44
                    }
                ]
            }

+ Response 401

    [1161][]

+ Response 429

    [89][]

+ Response 404

    [1011][]


+ Response 400

    [1167][]


## Review Count & Rating By Employee [/v1/review/report/count-by-rating/employee/{BusinessId}]
Review Count & Rating By Employee returns review count by rating associated with each assisted employee.

### Review Count & Rating By Employee [POST]

+ Parameters

    + BusinessId: 12345678 (string, required) - Id of the business.

+ Request (application/json)

    + Headers

            Accept: application/json
            x-api-key: [Required] Partner specific API key provided by Birdeye for data exchange.

    + Attributes

        + businessNumbers: 145308764185002,145308769721320 (array) - Business Numbers under enterprise account.
        + sourceAlias: google (string) - Alias of the source.
        + fromDate: 04/01/2013 (string) - Review date (start).
        + toDate: 04/01/2013 (string) - Review date (end).
        + employees (array) - Employee details for which review count will be fetched.
            + (object)
                + firstName: Ron (string) - Employee's first name.
                + lastName: Spector (string) - Employee's last name.
                + phone: 4424242424 (string) - Employee's phone number.

    + Body

            {
                "businessNumbers": [145308764185002,145308769721320],
                "sourceAlias": ["google","citysearch"],
                "employees": [{
                    "firstName": "David",
                    "lastName": "Wood",
                    "phone": "4424242424"
                }],
                "fromDate": "04/01/2013",
                "toDate": "05/3/2015"
            }


+ Response 200  (application/json)

    + Attributes
        + employees (array) - Employee details for which review count will be fetched.
            + (object)
                + employee
                    + firstName: Ron (string) - Employee's first name.
                    + lastName: Spector (string) - Employee's last name.
                    + phone: 4424242424 (string) - Employee's phone number.
                + countByRating (array) - Review count against each possible review rating. For Facebook recommended and non-recommended reviews rating will be 0.
                    + (object)
                        + rating: 5 (number) -  Review Rating.
                        + count: 140 (number) -  Number of reviews according to rating.


    + Body

            {
              "employees": [
                {
                  "employee": {
                    "firstName": "David",
                    "lastName": "Wood",
                    "phone": "4424242424"
                  },
                  "countByRating": [
                    {
                      "rating": 0,
                      "count": 0
                    },
                    {
                      "rating": 1,
                      "count": 1
                    },
                    {
                      "rating": 2,
                      "count": 0
                    },
                    {
                      "rating": 3,
                      "count": 0
                    },
                    {
                      "rating": 4,
                      "count": 2
                    },
                    {
                      "rating": 5,
                      "count": 1
                    }
                  ]
                }
              ]
            }

+ Response 401

    [1161][]

+ Response 429

    [89][]

+ Response 404

    [1011][]


+ Response 400

    [1167][]



## Insights Category Report by location [/v1/keywords/opmetric/location{?businessId}]
Insights Category Report by location provides the location-wise insights category data in the response.


### Insights Category Report by location report [POST]

+ Parameters
    + businessId: 12345678 (number, required) - Id of the Business.


+ Request (application/json)

    + Headers

            Accept: application/json
            x-api-key: [Required] Partner specific API key provided by Birdeye for data exchange.

    + Attributes
        + startDate: 04/01/2013 (string) - Start Date format MM/dd/YYYY.
        + endDate: 05/3/2015 (string) - End Date format MM/dd/YYYY.
        + reviewSites: 2,110,1,100 (array) - List of Souce Ids.
        + businessNumbers: 9489687712,2136910876 (array) -  List of business numbers.

    + Body

            {
                "startDate":"04/01/2013",
                "endDate":"05/3/2015",
                "reviewSites":["2","110","1","100","3","303","6","84","33","202","25","21","4","5","63"],
                "businessNumbers":["9489687712","2136910876"]
            }


+ Response 200 (application/json)

    + Attributes (array)
        + (object)
            + alias: 7653 Xrtrm Balltown Rd (string) - Alias of the location.
            + avgScore: 10 (number) - Average score of the keywords inside the category.
            + grade: A (string) - Grade of the keywords.
            + totalCount: 1679 (number) - Total count of keyword present.
            + metricForLocn - Location wise metric data.
                + Category_Name - This will be the name of the category like Beverages.
                    + category: Assortment (string) - Category name.
                    + avgScore: 3.4 (number) - Average score.
                    + count: 12 (number) - Count.
                    + grade: B+ (string) - Grade.
                    + parentCategory: Beverages (string) - Parent category name.


    + Body

            [{
                "alias": "7653 - Xrtrm - Balltown Rd",
                "avgScore": 4,
                "grade": "A",
                "totalCount": 1679,
                "metricForLocn": {
                    "Beverages": {
                        "category": "Beverages",
                        "avgScore": 3.8,
                        "count": 5,
                        "grade": "B+"
                    },
                    "Assortment (Beverages)": {
                        "category": "Assortment",
                        "parentCategory": "Beverages",
                        "avgScore": 5,
                        "count": 1,
                        "grade": "A+"
                    },
                    "Utensils": {
                        "category": "Utensils",
                        "avgScore": 0,
                        "count": 0
                    }
                }
            }]


+ Response 404

    [1011][]

+ Response 401

    [1167][]

+ Response 401

    [1161][]

+ Response 429

    [89][]


## Competitive Ranking [/v2/competitive/ranking{?businessId}]
Competitive Ranking Report provides the competitors ranking & rating data in the response for a business.


### Competitive Ranking Report [POST]

+ Parameters
    + businessId: 12345678 (number, required) - Id of the Business.



+ Request (application/json)

    + Headers

            Accept: application/json
            x-api-key: [Required] Partner specific API key provided by Birdeye for data exchange.

    + Attributes
        + startDate: 04/01/2013 (string) - Start Date format MM/dd/YYYY.
        + endDate: 05/3/2015 (string) - End Date format MM/dd/YYYY.
        + reviewSites: 2,110,1,100 (array) - List of Souce Ids.

    + Body

            {
                "startDate":"10/08/2019",
                "endDate":"01/15/2020",
                "reviewSites":["2","110"]
            }


+ Response 200 (application/json)

    + Attributes
        + positiveCount: 218305 (number) - Number of positive keywords.
        + neutralCount: 18600 (number) - Number of neutral keywords.
        + negativeCount: 22794 (number) - Number of negative keywords..
        + positivePercent: 84.0 (number) - Positive keyword percentage.
        + neutralPercent: 7.0 (number) - Neutral keyword percentage.
        + negativePercent: 9.0 (number) - Negative keyword percentage.
        + name: Pizza Palace (string) - Enterprise name.
        + count: 259699 (number) - Total Count.
        + rating: 4.3 (number) - Average rating.
        + competitors (array) - Competitors data.
            + (object)
                + positiveCount: 249953 (number) - Number of positive keywords.
                + neutralCount: 21827 (number) - Number of neutral keywords.
                + negativeCount: 16876 (number) - Number of negative keywords..
                + positivePercent: 87.0 (number) - Positive keyword percentage.
                + neutralPercent: 8.0 (number) - Neutral keyword percentage.
                + negativePercent: 6.0 (number) - Negative keyword percentage.
                + name: Family Pizza (string) - Enterprise name.
                + count: 288656 (number) - Total count.
                + rating: 4.45 (number) - Average rating.


    + Body

            {
                "positiveCount" : 218305,
                "neutralCount" : 18600,
                "negativeCount" : 22794,
                "positivePercent" : 84.0,
                "neutralPercent" : 7.0,
                "negativePercent" : 9.0,
                "name" : "Pizza Palace",
                "count" : 259699,
                "rating" : 4.339487006543244,
                "competitors" : [ {
                    "positiveCount" : 249953,
                    "neutralCount" : 21827,
                    "negativeCount" : 16876,
                    "positivePercent" : 87.0,
                    "neutralPercent" : 8.0,
                    "negativePercent" : 6.0,
                    "name" : "Family Pizza",
                    "count" : 288656,
                    "rating" : 4.457812929751687
                },
                {
                    "positiveCount" : 13148,
                    "neutralCount" : 2239,
                    "negativeCount" : 2051,
                    "positivePercent" : 75.0,
                    "neutralPercent" : 13.0,
                    "negativePercent" : 12.0,
                    "name" : "Veggie Pizza and Grill",
                    "count" : 17438,
                    "rating" : 4.126577756608716
                }]
            }



+ Response 404

    [1011][]

+ Response 401

    [1167][]

+ Response 401

    [1161][]

+ Response 429

    [89][]


## NPS Over time [/v1/reports/nps/time/elst{?businessId}]
NPS Over time gives you the NPS score for a selected period of time for all locations across businesses and the count of promoters, passives, and detractors for this business. The report can be grouped per day/week/month/year.

### NPS Over time Report [POST]

+ Parameters
    + businessId: 12345678 (number, required) - Id of the Business.


+ Request (application/json)

    + Headers

            Accept: application/json
            x-api-key: [Required] Partner specific API key provided by Birdeye for data exchange.

    + Attributes
        + startDate: 04/01/2013 (string) - Start Date format MM/dd/YYYY.
        + endDate: 05/3/2015 (string) - End Date format MM/dd/YYYY.
        + reviewSites: 2,110,1,100 (array) - List of Souce Ids.

    + Body

            {
                "startDate":"10/08/2019",
                "endDate":"01/15/2020",
                "reviewSites":["2","110"]
            }


+ Response 200 (application/json)

    + Attributes
        + totalCount: 190322 (number) - Total number of promoters, passives, and detractors.
        + avgNpsScore: 48.6 (number) - Average NPS score.
        + promoters: 63.1 (number) - Total number of promoters.
        + passives: 22.4 (number) - Total number of passives.
        + detractors: 14.5 (number) - Total number of detractors.
        + dataPoints (array) - Data points.
            + (object)
                + nodeId: 9 (number) - Node Id.
                + label: Jul 2009 - Sep 2009 (string) - Label.
                + shortLabel: Q3 2009 (string) - Short Label.
                + startDate: 07/21/2009 (string) - Start date.
                + endDate: 09/30/2009 (string) - End date.
                + totalCount: 1 (number) - Count.
                + detractorPercentile: 100 (number) - Detractor Percentile.
                + passivePercentile: 0 (number) - Passive Percentile.
                + npsScore: /-100 (number) - Average NPS Score.
                + positiveCount: 0 (number) - Positive Count.
                + negativeCount: 1 (number) - Negative Count.
                + neutralCount: 0 (number) - Neutral Count.
        + groupByType: quarter (string) - Grouping by.
        + dateDiff: 324 (number) - Date difference.


    + Body

            {
                  "totalCount": 2,
                  "avgNpsScore": "-50",
                  "promoters": "0",
                  "passives": "50",
                  "detractors": "50",
                  "dataPoints": [
                    {
                      "label": "10/08/2019 - 10/13/2019",
                      "shortLabel": "Oct 08-Oct 13 2019",
                      "startDate": "10/08/2019",
                      "endDate": "10/13/2019",
                      "dynamicLabel": {
                        "header": "label",
                        "value": "10/08/2019",
                        "order": 2147483647,
                        "cellType": "TEXT"
                      },
                      "detractorPercentile": 100,
                      "passivePercentile": 0,
                      "promoterPercentile": 0,
                      "npsScore": -100,
                      "positiveCount": 0,
                      "negativeCount": 1,
                      "neutralCount": 0,
                      "totalCount": 1
                    },
                    {
                      "label": "10/14/2019 - 10/20/2019",
                      "shortLabel": "Oct 14-Oct 20 2019",
                      "startDate": "10/14/2019",
                      "endDate": "10/20/2019",
                      "dynamicLabel": {
                        "header": "label",
                        "value": "10/14/2019",
                        "order": 2147483647,
                        "cellType": "TEXT"
                      },
                      "detractorPercentile": 0,
                      "passivePercentile": 100,
                      "promoterPercentile": 0,
                      "npsScore": 0,
                      "positiveCount": 0,
                      "negativeCount": 0,
                      "neutralCount": 1,
                      "totalCount": 1
                    }
                  ],
                  "groupByType": "week",
                  "dateDiff": 100
                }



+ Response 404

    [1011][]

+ Response 401

    [1167][]

+ Response 401

    [1161][]

+ Response 429

    [89][]


## NPS By Location [/v1/reports/nps/location/elst{?businessId}]
NPS By Location gives you the NPS score for each location and the count of promoters, passives, and detractors for the business.


### NPS By Location Report [POST]

+ Parameters
    + businessId: 12345678 (number, required) - Id of the Business.



+ Request (application/json)

    + Headers

            Accept: application/json
            x-api-key: [Required] Partner specific API key provided by Birdeye for data exchange.

    + Attributes
        + startDate: 04/01/2013 (string) - Start Date format MM/dd/YYYY.
        + endDate: 05/3/2015 (string) - End Date format MM/dd/YYYY.
        + reviewSites: 2,110,1,100 (array) - List of Souce Ids.
        + businessNumbers: 9489676910876,9434065498803 (array) - List of business numbers.

    + Body

            {
                "startDate":"10/08/2019",
                "endDate":"01/15/2020",
                "reviewSites":["2","110"],
                "businessNumbers": ["9489676910876", "9434065498803"]
            }


+ Response 200 (application/json)

    + Attributes
        + totalCount: 190322 (number) - Total number of promoters, passives, and detractors.
        + avgNpsScore: 48.6 (number) - Average NPS score.
        + promoters: 63.1 (number) - Total number of promoters.
        + passives: 22.4 (number) - Total number of passives.
        + detractors: 14.5 (number) - Total number of detractors.
        + dataPoints (array) - Data points.
            + (object)
                + nodeId: 9 (number) - Node Id.
                + label: Anjou (string) - Location Name.
                + detractorPercentile: 100 (number) - Detractor Percentile.
                + passivePercentile: 0 (number) - Passive Percentile.
                + promoterPercentile: 0 (number) - Promoter Percentile.
                + npsScore: /-100 (number) - Average NPS Score.
                + positiveCount: 0 (number) - Positive Count.
                + negativeCount: 1 (number) - Negative Count.
                + neutralCount: 0 (number) - Neutral Count.
                + totalCount: 100 (number) - Total Count.
                + businessNumber: 172712121274890 (number) - Business number of the location
        + groupByType: quarter (string) - Grouping by.
        + dateDiff: 324 (number) - Date difference.
        + totalPages: 1 (number) - Total number of pages.
        + page: 0 (number) - Current Page.
        + size: 1 (number) - Size.

    + Body

            {
                  "totalCount": 2,
                  "avgNpsScore": "-50",
                  "promoters": "0",
                  "passives": "50",
                  "detractors": "50",
                  "dataPoints": [
                    {
                      "nodeId": 1398773,
                      "label": "Anjou",
                      "dynamicLabel": {
                        "header": "Location",
                        "value": "Anjou",
                        "order": 2147483647,
                        "cellType": "TEXT"
                      },
                      "detractorPercentile": 50,
                      "passivePercentile": 50,
                      "promoterPercentile": 0,
                      "npsScore": -50,
                      "positiveCount": 0,
                      "negativeCount": 1,
                      "neutralCount": 1,
                      "totalCount": 2,
                      "businessNumber": 172712121274890
                    }
                  ],
                  "dateDiff": 100,
                  "totalPages": 1,
                  "page": 0,
                  "size": 1
                }



+ Response 404

    [1011][]

+ Response 401

    [1167][]

+ Response 401

    [1161][]

+ Response 429

    [89][]



## Review By Source [/v1/reports/count/reviewsite{?businessId}]
Review By Source  API groups the number of reviews and average ratings in an account according to the aggregation source.

### Review By Source Report [POST]


+ Parameters
    + businessId: 12345678 (number, required) - Id of the Business.


+ Request (application/json)

    + Headers

            Accept: application/json
            x-api-key: [Required] Partner specific API key provided by Birdeye for data exchange.

    + Attributes
        + sourceAliases: citysearch,google (array) - List of source aliases.
        + businessNumbers: 943967608,943476803 (array) - List of business number.
        + months: 12 (number) - Use to get results for last some months.

    + Body

            {
                "sourceAliases": ["citysearch ", "google"],
                "businessNumbers": ["943967608", "943476803"],
                "months": 12
            }


+ Response 200 (application/json)

    + Attributes (array)
        + (object)
            + count: 10 (number) - Number of reviews for the particular location.
            + milestone: Smile dental (string) - Name of the Location.
            + businessId: 943967608 (number) - Business number of the location.
            + reviewSites (array) - List of source Alias.
                + (object)
                    + sourceAlias: Citysearch (string) - Source alias.
                    + count: 5 (number) - Number of reviews in sources.


    + Body

            [{
                "count": 1132,
                "milestone": "Smile Dental",
                "businessId": "943967608",
                "reviewSites": [{
                    "sourceAlias": "Citysearch",
                    "count": 4
                },
                {
                    "sourceAlias": "GooglePlay",
                    "count": 1060
                },
                {
                    "sourceAlias": "bestcreditrepaircompany",
                    "count": 1
                 },
                 {
                    "sourceAlias": "Birdeye",
                    "count": 67
                 }
                ]
              }
            ]



+ Response 404

    [1011][]

+ Response 401

    [1167][]

+ Response 401

    [1161][]

+ Response 429

    [89][]

## Visitor report [/v1/reports/count/visitors{?businessId}]
Visitor report groups the data according to source.

### Visitor report [POST]


+ Parameters
    + businessId: 12345678 (number, required) - Id of the Business.


+ Request (application/json)

    + Headers

            Accept: application/json
            x-api-key: [Required] Partner specific API key provided by Birdeye for data exchange.

    + Attributes
        + sourceAliases: citysearch,google (array) - List of source aliases.
        + businessNumbers: 943967608,943476803 (array) - List of business number.
        + months: 12 (number) - Use to get results for last some months.

    + Body

            {
                "sourceAliases": ["citysearch ", "google"],
                "businessNumbers": ["943967608", "943476803"],
                "months": 12
            }


+ Response 200 (application/json)

    + Attributes (array)
        + (object)
            + count: 315 (number) - Number of visitor for the particular locations.
            + milestone: Smile dental (string) - Name of the Location.
            + businessId: 943967608 (number) - Business number of the location.
            + visitors (array) - Visitor data.
                + (object)
                    + sourceAlias: Citysearch (string) - Source alias.
                    + count: 5 (number) - Number of visits at source side.


    + Body

            [{
                "count": 315,
                "milestone": "Smile Dental",
                "businessId": "943967608",
                "visitors": [
                    {
                        "sourceAlias": "Facebook",
                        "count": 0
                    },
                    {
                        "sourceAlias": "Google",
                        "count": 0
                    },
                    {
                        "sourceAlias": "Twitter",
                        "count": 0
                    },
                    {
                        "sourceAlias": "Review Site",
                        "count": 289
                    },
                    {
                        "sourceAlias": "Website",
                        "count": 26
                    },
                    {
                        "sourceAlias": "Total",
                        "count": 315
                    }
                ]

            }]



+ Response 404

    [1011][]

+ Response 401

    [1167][]

+ Response 401

    [1161][]

+ Response 429

    [89][]





## Usage report [/v1/reports/usage{?reportType,sindex,count,business_id}]
Usage report gives the usage details for the review requests, and the number of requests sent, opened and clicked.


### Usage report [POST]

+ Parameters
    + business_id: 12345678 (number, required) - Id of the Business.
    + reportType: rating (string, required) - The type of Report - Summary or Tabular.
    + sindex: 0 (number, required) - The starting index of the reviews
    + count: 100 (string, required) - The number of reviews to query


+ Request (application/json)

    + Headers

            Accept: application/json
            x-api-key: [Required] Partner specific API key provided by Birdeye for data exchange.

    + Attributes
        + startDate: 04/01/2013 (string) - Start date.
        + endDate: 05/3/2015 (string) -  End date.
        + reviewSites: 1,2,110,41 (array) - List of review sites.
        + ratings: 1,2,3,4,5,0 (array) - List of ratings.
        + days: 7 (number) - Use to get results for last some days.
        + groupByDays: 1 (number) - Group by days.
        + reviewSiteAllFlag: true (boolean) - Pass true if you want to get data from all sources.

    + Body

            {
                "startDate":"04/01/2013",
                "endDate":"05/3/2015",
                "reviewSites":["2","110","1","100","3","303","6","84","33","202","25","21","4","5","63"],
                "ratings":[1,2,3,4,5,0],
                "days":7
                "groupByDays":1,
                "reviewSiteAllFlag":true
            }


+ Response 200 (application/json)


    + Body

            [{
                "name": "Total",
                "alias1": "Total",
                "emailSentInfo": {
                    "total": 15990,
                    "percent": 0,
                    "reqCount": 15990,
                    "reqReminderCount": 37034,
                    "shareReqCount": 0,
                    "shareReqReminderCount": 0
                },
                "emailOpenInfo": {
                    "total": 10316,
                    "percent": 64.5,
                    "reqCount": 10316,
                    "reqReminderCount": 0,
                    "shareReqCount": 0,
                    "shareReqReminderCount": 0
                },
                "emailClickInfo": {
                    "total": 1370,
                    "percent": 8.6,
                    "rcmdCount": [
                        {
                            "name": "Google",
                            "count": 683,
                            "percent": 49.9,
                            "sourceId": 2
                        },
                        {
                            "name": "Facebook",
                            "count": 263,
                            "percent": 19.2,
                            "sourceId": 110
                        },
                        {
                            "name": "Birdeye",
                            "count": 4,
                            "percent": 0.3,
                            "sourceId": 100
                        }
                    ],
                    "nonRcmdCount": [
                        {
                            "name": "Birdeye",
                            "count": 420,
                            "percent": 30.7,
                            "sourceId": 100
                        }]
                    },
                    "rcmdReviewsCount": [
                    {
                        "sourceId": 2,
                        "sourceName": "Google",
                        "sourceAlias": "Google",
                        "avgRating": null,
                        "reviewCount": 1297
                    },
                    {
                        "sourceId": 110,
                        "sourceName": "Facebook",
                        "sourceAlias": "Facebook",
                        "avgRating": null,
                        "reviewCount": 517
                    },
                    {
                        "sourceId": 100,
                        "sourceName": "Birdeye",
                        "sourceAlias": "birdeye",
                        "avgRating": null,
                        "reviewCount": 176
                    },
                    {
                        "sourceId": 1,
                        "sourceName": "Yelp",
                        "sourceAlias": "Yelp",
                        "avgRating": null,
                        "reviewCount": 171
                    },
                    {
                        "sourceId": 25,
                        "sourceName": "The Knot",
                        "sourceAlias": "The Knot",
                        "avgRating": null,
                        "reviewCount": 6
                    },
                    {
                        "sourceId": 21,
                        "sourceName": "Wedding Wire",
                        "sourceAlias": "Wedding Wire",
                        "avgRating": null,
                        "reviewCount": 1
                    }
                    ],
                    "nonRcmdReviewsCount": [
                    {
                        "sourceId": 100,
                        "sourceName": "Birdeye",
                        "sourceAlias": "birdeye",
                        "avgRating": null,
                        "reviewCount": 516
                    }
                    ],
                    "smsSentInfo": {
                        "total": 39980,
                        "percent": 0,
                        "reqCount": 39980,
                        "reqReminderCount": 0,
                        "shareReqCount": 0,
                        "shareReqReminderCount": 0
                    },
                    "smsOpenInfo": {
                        "total": 2340,
                        "percent": 5.9,
                        "reqCount": 2340,
                        "reqReminderCount": 0,
                        "shareReqCount": 0,
                        "shareReqReminderCount": 0
                    },
                    "smsClickInfo": {
                        "total": 1558,
                        "percent": 3.9,
                        "rcmdCount": [
                        {
                            "name": "Google",
                            "count": 850,
                            "percent": 54.6,
                            "sourceId": 2
                        },
                        {
                            "name": "Facebook",
                            "count": 425,
                            "percent": 27.3,
                            "sourceId": 110
                        },
                        {
                            "name": "Birdeye",
                            "count": 2,
                            "percent": 0.1,
                            "sourceId": 100
                        }
                        ],
                        "nonRcmdCount": [
                            {
                                "name": "Birdeye",
                                "count": 281,
                                "percent": 18,
                                "sourceId": 100
                            }
                            ]
                        },
                        "totalReviewsCount": 2684
                    }
                ]


+ Response 404

    [1011][]

+ Response 401

    [1167][]

+ Response 401

    [1161][]

+ Response 429

    [89][]

## Review Response Rate Over Time [/v1/review/report/response-rate/time/rate-over-time]
Review Response Rate Over Time API returns response-rate trends over time, with optional previous-period comparison.

### Review Response Rate Over Time [POST]

+ Request (application/json)

    + Headers

            Accept: application/json
            x-api-key: [Required] Partner specific API key provided by Birdeye for data exchange.
            x-business-number: [Required] Business number of the location.

    + Attributes
        + reviewSites: 2,1,110,100 (array) - List of review site IDs.
        + ratings: 0,1,3,4,5 (array) - Ratings to include in the report.
        + businessNumbers: 172957184851864,174436684666401 (array) - List of business numbers.
        + startDate: 02/25/2025 (string) - Start date in `MM/dd/YYYY` format.
        + endDate: 02/01/2026 (string) - End date in `MM/dd/YYYY` format.
        + comparisonFilter (object) - Comparison date range.
            + startDate: 01/01/2025 (string) - Comparison start date in `MM/dd/YYYY` format.
            + endDate: 01/10/2025 (string) - Comparison end date in `MM/dd/YYYY` format.

    + Body

            {
                "reviewSites": [2, 1, 110, 100],
                "ratings": ["0", "1", "3", "4", "5"],
                "businessNumbers": [172957184851864, 174436684666401],
                "startDate": "02/25/2025",
                "endDate": "02/01/2026",
                "comparisonFilter": {
                    "startDate": "01/01/2025",
                    "endDate": "01/10/2025"
                }
            }

+ Response 200 (application/json)

    + Attributes
        + summary (object)
            + actual (object)
                + totalCount: 94 (number) - Total number of reviews in selected period.
                + avgRating: 4.2 (number) - Average rating in selected period.
                + responseRate: 5 (number) - Response rate percentage.
                + unrespondedRate: 95 (number) - Unresponded rate percentage.
                + unrespondedCount: 89 (number) - Count of unresponded reviews.
                + respondedCount: 5 (number) - Count of responded reviews.
                + unrespondedCountGrowth: 89.4 (number) - Growth percentage against comparison period.
                + respondedCountGrowth: 400.0 (number) - Growth percentage against comparison period.
                + totalCountGrowth: 95.8 (number) - Growth percentage against comparison period.
                + responseRateGrowth: 150.0 (number) - Growth percentage against comparison period.
            + compare (object)
                + totalCount: 48 (number) - Total number of reviews in comparison period.
                + avgRating: 4.1 (number) - Average rating in comparison period.
                + responseRate: 2 (number) - Response rate percentage in comparison period.
                + unrespondedRate: 98 (number) - Unresponded rate percentage in comparison period.
                + unrespondedCount: 47 (number) - Count of unresponded reviews in comparison period.
                + respondedCount: 1 (number) - Count of responded reviews in comparison period.
        + dataPoints (array) - Time-series points for actual and comparison periods.
            + (object)
                + actual (object)
                    + label: Feb 24, 2025 - Mar 2, 2025 (string) - Display label for the bucket.
                    + shortLabel: Feb 24 - Mar 2 '25 (string) - Short display label.
                    + totalCount: 0 (number) - Total reviews in the bucket.
                    + startDate: 02/24/2025 (string) - Bucket start date.
                    + endDate: 03/02/2025 (string) - Bucket end date.
                    + responseRate: 0 (number) - Response rate percentage.
                    + unrespondedCount: 0 (number) - Unresponded review count.
                    + respondedCount: 0 (number) - Responded review count.
                    + respondedCountGrowth: 0.0 (number) - Growth percentage.
                    + totalCountGrowth: 0.0 (number) - Growth percentage.
                    + responseRateGrowth: 0.0 (number) - Growth percentage.
                + compare (object)
                    + label: Mar 19, 2024 - Mar 24, 2024 (string) - Comparison label for the bucket.
                    + shortLabel: Mar 19 - Mar 24 '24 (string) - Short comparison label.
                    + totalCount: 0 (number) - Comparison total reviews in the bucket.
                    + startDate: 03/19/2024 (string) - Comparison bucket start date.
                    + endDate: 03/24/2024 (string) - Comparison bucket end date.
                    + responseRate: 0 (number) - Comparison response rate percentage.
                    + unrespondedCount: 0 (number) - Comparison unresponded review count.
                    + respondedCount: 0 (number) - Comparison responded review count.
        + dateDiff: 341 (number) - Date range difference.
        + groupByType: week (string) - Grouping unit used in data points.
        + dataPresent: true (boolean) - Indicates whether report data is present.

    + Body

            {
                "summary": {
                    "actual": {
                        "totalCount": 94,
                        "avgRating": 4.2,
                        "responseRate": 5,
                        "unrespondedRate": 95,
                        "unrespondedCount": 89,
                        "respondedCount": 5,
                        "unrespondedCountGrowth": 89.4,
                        "respondedCountGrowth": 400.0,
                        "totalCountGrowth": 95.8,
                        "responseRateGrowth": 150.0
                    },
                    "compare": {
                        "totalCount": 48,
                        "avgRating": 4.1,
                        "responseRate": 2,
                        "unrespondedRate": 98,
                        "unrespondedCount": 47,
                        "respondedCount": 1
                    }
                },
                "dataPoints": [
                    {
                        "actual": {
                            "label": "Feb 24, 2025 - Mar 2, 2025",
                            "shortLabel": "Feb 24 - Mar 2 '25",
                            "totalCount": 0,
                            "startDate": "02/24/2025",
                            "endDate": "03/02/2025",
                            "responseRate": 0,
                            "unrespondedCount": 0,
                            "respondedCount": 0,
                            "respondedCountGrowth": 0.0,
                            "totalCountGrowth": 0.0,
                            "responseRateGrowth": 0.0
                        },
                        "compare": {
                            "label": "Mar 19, 2024 - Mar 24, 2024",
                            "shortLabel": "Mar 19 - Mar 24 '24",
                            "totalCount": 0,
                            "startDate": "03/19/2024",
                            "endDate": "03/24/2024",
                            "responseRate": 0,
                            "unrespondedCount": 0,
                            "respondedCount": 0
                        }
                    }
                ],
                "dateDiff": 341,
                "groupByType": "week",
                "dataPresent": true
            }

+ Response 401

    [1161][]

+ Response 429

    [89][]

+ Response 400

    [1167][]


## Review Response Rate By Location Overview [/v1/review/report/response-rate/by-location/overview{?order,sortBy,startIndex,size}]
Review Response Rate By Location Overview API returns location-wise response-rate metrics.

### Review Response Rate By Location Overview [POST]

+ Parameters
    + order: 1 (number, optional) - Sort order. `1` for descending, `0` for ascending.
    + sortBy: rate (string, optional) - Field used for sorting, for example `rate`.
    + startIndex: 0 (number, optional) - Starting index for pagination.
    + size: 100 (number, optional) - Number of records to return.

+ Request (application/json)

    + Headers

            Accept: application/json
            x-api-key: [Required] Partner specific API key provided by Birdeye for data exchange.
            x-business-number: [Required] Business number of the location.

    + Attributes
        + reviewSites: 2,1,110,100 (array) - List of review site IDs.
        + ratings: 0,1,3,4,5 (array) - Ratings to include in the report.
        + businessNumbers: 172957184851864,174436684666401 (array) - List of business numbers.
        + startDate: 02/25/2025 (string) - Start date in `MM/dd/YYYY` format.
        + endDate: 02/01/2026 (string) - End date in `MM/dd/YYYY` format.
        + comparisonFilter (object) - Comparison date range.
            + startDate: 01/01/2025 (string) - Comparison start date in `MM/dd/YYYY` format.
            + endDate: 01/10/2025 (string) - Comparison end date in `MM/dd/YYYY` format.

    + Body

            {
                "reviewSites": [2, 1, 110, 100],
                "ratings": ["0", "1", "3", "4", "5"],
                "businessNumbers": [172957184851864, 174436684666401],
                "startDate": "02/25/2025",
                "endDate": "02/01/2026",
                "comparisonFilter": {
                    "startDate": "01/01/2025",
                    "endDate": "01/10/2025"
                }
            }

+ Response 200 (application/json)

    + Attributes
        + summary (object)
            + actual (object)
                + totalCount: 0 (number) - Total number of reviews.
                + responseRate: 0 (number) - Response rate percentage.
                + unrespondedRate: 0 (number) - Unresponded rate percentage.
                + unrespondedCount: 0 (number) - Count of unresponded reviews.
                + respondedCount: 0 (number) - Count of responded reviews.
            + compare (object)
                + totalCount: 0 (number) - Total number of reviews in comparison period.
                + responseRate: 0 (number) - Response rate percentage in comparison period.
                + unrespondedRate: 0 (number) - Unresponded rate percentage in comparison period.
                + unrespondedCount: 0 (number) - Count of unresponded reviews in comparison period.
                + respondedCount: 0 (number) - Count of responded reviews in comparison period.
        + dataPoints (array) - Location-wise response-rate metrics.
            + (object)
                + actual (object)
                    + label: Plano, TX (string) - Location label.
                    + totalCount: 0 (number) - Total number of reviews for the location.
                    + responseRate: 0 (number) - Response rate percentage for the location.
                    + unrespondedRate: 0 (number) - Unresponded rate percentage for the location.
                    + unrespondedCount: 0 (number) - Count of unresponded reviews for the location.
                    + respondedCount: 0 (number) - Count of responded reviews for the location.
                    + businessNumber: 175457918679707 (number) - Business number of the location.
                + compare (object)
                    + label: Plano, TX (string) - Comparison location label.
                    + totalCount: 0 (number) - Comparison total number of reviews for the location.
                    + responseRate: 0 (number) - Comparison response rate percentage for the location.
                    + unrespondedRate: 0 (number) - Comparison unresponded rate percentage for the location.
                    + unrespondedCount: 0 (number) - Comparison unresponded reviews for the location.
                    + respondedCount: 0 (number) - Comparison responded reviews for the location.
                    + businessNumber: 175457918679707 (number) - Business number of the location.
        + dataPresent: false (boolean) - Indicates whether report data is present.

    + Body

            {
                "summary": {
                    "actual": {
                        "totalCount": 0,
                        "responseRate": 0,
                        "unrespondedRate": 0,
                        "unrespondedCount": 0,
                        "respondedCount": 0
                    },
                    "compare": {
                        "totalCount": 0,
                        "responseRate": 0,
                        "unrespondedRate": 0,
                        "unrespondedCount": 0,
                        "respondedCount": 0
                    }
                },
                "dataPoints": [
                    {
                        "actual": {
                            "label": "Plano, TX",
                            "totalCount": 0,
                            "responseRate": 0,
                            "unrespondedRate": 0,
                            "unrespondedCount": 0,
                            "respondedCount": 0,
                            "businessNumber": 175457918679707
                        },
                        "compare": {
                            "label": "Plano, TX",
                            "totalCount": 0,
                            "responseRate": 0,
                            "unrespondedRate": 0,
                            "unrespondedCount": 0,
                            "respondedCount": 0,
                            "businessNumber": 175457918679707
                        }
                    },
                    {
                        "actual": {
                            "label": "Honda Complex",
                            "totalCount": 0,
                            "responseRate": 0,
                            "unrespondedRate": 0,
                            "unrespondedCount": 0,
                            "respondedCount": 0,
                            "businessNumber": 175700720136654
                        },
                        "compare": {
                            "label": "Honda Complex",
                            "totalCount": 0,
                            "responseRate": 0,
                            "unrespondedRate": 0,
                            "unrespondedCount": 0,
                            "respondedCount": 0,
                            "businessNumber": 175700720136654
                        }
                    }
                ],
                "dataPresent": false
            }

+ Response 401

    [1161][]

+ Response 429

    [89][]

+ Response 400

    [1167][]


## Average Response Time By Location [/v1/review/report/avg-response-time/by-location{?order,sortBy,startIndex,size}]
Average Response Time By Location API returns location-wise average response-time metrics.

### Average Response Time By Location [POST]

+ Parameters
    + order: 1 (number, optional) - Sort order. `1` for descending, `0` for ascending.
    + sortBy: avg-resp-time (string, optional) - Field used for sorting.
    + startIndex: 0 (number, optional) - Starting index for pagination.
    + size: 100 (number, optional) - Number of records to return.

+ Request (application/json)

    + Headers

            Accept: application/json
            x-api-key: [Required] Partner specific API key provided by Birdeye for data exchange.
            x-business-number: [Required] Business number of the location.

    + Attributes
        + reviewSites: 2,1,110,100 (array) - List of review site IDs.
        + ratings: 0,1,3,4,5 (array) - Ratings to include in the report.
        + businessNumbers: 172957184851864,174436684666401 (array) - List of business numbers.
        + startDate: 02/25/2025 (string) - Start date in `MM/dd/YYYY` format.
        + endDate: 02/01/2026 (string) - End date in `MM/dd/YYYY` format.
        + comparisonFilter (object) - Comparison date range.
            + startDate: 01/01/2025 (string) - Comparison start date in `MM/dd/YYYY` format.
            + endDate: 01/10/2025 (string) - Comparison end date in `MM/dd/YYYY` format.

    + Body

            {
                "reviewSites": [2, 1, 110, 100],
                "ratings": ["0", "1", "3", "4", "5"],
                "businessNumbers": [172957184851864, 174436684666401],
                "startDate": "02/25/2025",
                "endDate": "02/01/2026",
                "comparisonFilter": {
                    "startDate": "01/01/2025",
                    "endDate": "01/10/2025"
                }
            }

+ Response 200 (application/json)

    + Attributes
        + summary (object)
            + actual (object)
                + avgResponseTime (object)
                    + days: 2357.9 (number) - Average response time in days.
                    + hours: 56589.57 (number) - Average response time in hours.
                    + minutes: 3395374.0 (number) - Average response time in minutes.
                + respondedCount: 80 (number) - Number of responded reviews.
            + compare (object)
                + avgResponseTime (object)
                    + days: 0.0 (number) - Average response time in days for comparison period.
                    + hours: 0.0 (number) - Average response time in hours for comparison period.
                    + minutes: 0.0 (number) - Average response time in minutes for comparison period.
                + respondedCount: 0 (number) - Number of responded reviews in comparison period.
        + dataPoints (array) - Location-wise average response-time metrics.
            + (object)
                + actual (object)
                    + label: Vignesh (string) - Location label.
                    + avgResponseTime (object)
                        + days: 2493.24 (number) - Average response time in days for the location.
                        + hours: 59837.72 (number) - Average response time in hours for the location.
                        + minutes: 3590263.0 (number) - Average response time in minutes for the location.
                    + respondedCount: 70 (number) - Number of responded reviews for the location.
                    + businessNumber: 174436684666401 (number) - Business number of the location.
                + compare (object)
                    + label: Vignesh (string) - Comparison location label.
                    + avgResponseTime (object)
                        + days: 0.0 (number) - Comparison average response time in days.
                        + hours: 0.0 (number) - Comparison average response time in hours.
                        + minutes: 0.0 (number) - Comparison average response time in minutes.
                    + respondedCount: 0 (number) - Comparison responded reviews for the location.
                    + businessNumber: 174436684666401 (number) - Business number of the location.
        + dateDiff: 6792 (number) - Date range difference.
        + groupByType: quarter (string) - Grouping unit used in data points.
        + dataPresent: true (boolean) - Indicates whether report data is present.

    + Body

            {
                "summary": {
                    "actual": {
                        "avgResponseTime": {
                            "days": 2357.9,
                            "hours": 56589.57,
                            "minutes": 3395374.0
                        },
                        "respondedCount": 80
                    },
                    "compare": {
                        "avgResponseTime": {
                            "days": 0.0,
                            "hours": 0.0,
                            "minutes": 0.0
                        },
                        "respondedCount": 0
                    }
                },
                "dataPoints": [
                    {
                        "actual": {
                            "label": "Vignesh",
                            "avgResponseTime": {
                                "days": 2493.24,
                                "hours": 59837.72,
                                "minutes": 3590263.0
                            },
                            "respondedCount": 70,
                            "businessNumber": 174436684666401
                        },
                        "compare": {
                            "label": "Vignesh",
                            "avgResponseTime": {
                                "days": 0.0,
                                "hours": 0.0,
                                "minutes": 0.0
                            },
                            "respondedCount": 0,
                            "businessNumber": 174436684666401
                        }
                    },
                    {
                        "actual": {
                            "label": "Assembly Row",
                            "avgResponseTime": {
                                "days": 1410.52,
                                "hours": 33852.52,
                                "minutes": 2031151.4
                            },
                            "respondedCount": 10,
                            "businessNumber": 172957184851864
                        },
                        "compare": {
                            "label": "Assembly Row",
                            "avgResponseTime": {
                                "days": 0.0,
                                "hours": 0.0,
                                "minutes": 0.0
                            },
                            "respondedCount": 0,
                            "businessNumber": 172957184851864
                        }
                    }
                ],
                "dateDiff": 6792,
                "groupByType": "quarter",
                "dataPresent": true
            }

+ Response 401

    [1161][]

+ Response 429

    [89][]

+ Response 400

    [1167][]


## Average Response Time Over Time [/v1/review/report/avg-response-time/time]
Average Response Time Over Time API returns average response-time trends over time, with optional previous-period comparison.

### Average Response Time Over Time [POST]

+ Request (application/json)

    + Headers

            Accept: application/json
            x-api-key: [Required] Partner specific API key provided by Birdeye for data exchange.
            x-business-number: [Required] Business number of the location.

    + Attributes
        + reviewSites: 2,1,110,100 (array) - List of review site IDs.
        + ratings: 0,1,3,4,5 (array) - Ratings to include in the report.
        + businessNumbers: 172957184851864,174436684666401 (array) - List of business numbers.
        + startDate: 02/25/2025 (string) - Start date in `MM/dd/YYYY` format.
        + endDate: 02/01/2026 (string) - End date in `MM/dd/YYYY` format.
        + comparisonFilter (object) - Comparison date range.
            + startDate: 01/01/2025 (string) - Comparison start date in `MM/dd/YYYY` format.
            + endDate: 01/10/2025 (string) - Comparison end date in `MM/dd/YYYY` format.

    + Body

            {
                "reviewSites": [2, 1, 110, 100],
                "ratings": ["0", "1", "3", "4", "5"],
                "businessNumbers": [172957184851864, 174436684666401],
                "startDate": "02/25/2025",
                "endDate": "02/01/2026",
                "comparisonFilter": {
                    "startDate": "01/01/2025",
                    "endDate": "01/10/2025"
                }
            }

+ Response 200 (application/json)

    + Attributes
        + summary (object)
            + actual (object)
                + avgResponseTime (object)
                    + days: 2357.9 (number) - Average response time in days.
                    + hours: 56589.57 (number) - Average response time in hours.
                    + minutes: 3395374.0 (number) - Average response time in minutes.
                + respondedCount: 80 (number) - Number of responded reviews.
            + compare (object)
                + avgResponseTime (object)
                    + days: 0.0 (number) - Average response time in days for comparison period.
                    + hours: 0.0 (number) - Average response time in hours for comparison period.
                    + minutes: 0.0 (number) - Average response time in minutes for comparison period.
                + respondedCount: 0 (number) - Number of responded reviews in comparison period.
        + dataPoints (array) - Time-series data points with comparison period values.
            + (object)
                + actual (object)
                    + label: Apr 2017 - Jun 2017 (string) - Display label for the bucket.
                    + shortLabel: Q2 2017 (string) - Short display label.
                    + startDate: 04/01/2017 (string) - Bucket start date.
                    + endDate: 06/30/2017 (string) - Bucket end date.
                    + avgResponseTime (object)
                        + days: 27.08 (number) - Average response time in days.
                        + hours: 649.83 (number) - Average response time in hours.
                        + minutes: 38990.08 (number) - Average response time in minutes.
                    + respondedCount: 1 (number) - Number of responded reviews in the bucket.
                + compare (object)
                    + label: Apr 2016 - Jun 2016 (string) - Comparison label for the bucket.
                    + shortLabel: Q2 2016 (string) - Short comparison label.
                    + startDate: 04/01/2016 (string) - Comparison bucket start date.
                    + endDate: 06/30/2016 (string) - Comparison bucket end date.
                    + avgResponseTime (object)
                        + days: 0.0 (number) - Comparison average response time in days.
                        + hours: 0.0 (number) - Comparison average response time in hours.
                        + minutes: 0.0 (number) - Comparison average response time in minutes.
                    + respondedCount: 0 (number) - Comparison responded reviews in the bucket.
        + dateDiff: 6792 (number) - Date range difference.
        + groupByType: quarter (string) - Grouping unit used in data points.
        + dataPresent: true (boolean) - Indicates whether report data is present.

    + Body

            {
                "summary": {
                    "actual": {
                        "avgResponseTime": {
                            "days": 2357.9,
                            "hours": 56589.57,
                            "minutes": 3395374.0
                        },
                        "respondedCount": 80
                    },
                    "compare": {
                        "avgResponseTime": {
                            "days": 0.0,
                            "hours": 0.0,
                            "minutes": 0.0
                        },
                        "respondedCount": 0
                    }
                },
                "dataPoints": [
                    {
                        "actual": {
                            "label": "Apr 2017 - Jun 2017",
                            "shortLabel": "Q2 2017",
                            "startDate": "04/01/2017",
                            "endDate": "06/30/2017",
                            "avgResponseTime": {
                                "days": 27.08,
                                "hours": 649.83,
                                "minutes": 38990.08
                            },
                            "respondedCount": 1
                        },
                        "compare": {
                            "label": "Apr 2016 - Jun 2016",
                            "shortLabel": "Q2 2016",
                            "startDate": "04/01/2016",
                            "endDate": "06/30/2016",
                            "avgResponseTime": {
                                "days": 0.0,
                                "hours": 0.0,
                                "minutes": 0.0
                            },
                            "respondedCount": 0
                        }
                    },
                    {
                        "actual": {
                            "label": "Jul 2017 - Sep 2017",
                            "shortLabel": "Q3 2017",
                            "startDate": "07/01/2017",
                            "endDate": "09/30/2017",
                            "avgResponseTime": {
                                "days": 3.43,
                                "hours": 82.28,
                                "minutes": 4936.62
                            },
                            "respondedCount": 1
                        },
                        "compare": {
                            "label": "Jul 2016 - Sep 2016",
                            "shortLabel": "Q3 2016",
                            "startDate": "07/01/2016",
                            "endDate": "09/30/2016",
                            "avgResponseTime": {
                                "days": 0.0,
                                "hours": 0.0,
                                "minutes": 0.0
                            },
                            "respondedCount": 0
                        }
                    }
                ],
                "dateDiff": 6792,
                "groupByType": "quarter",
                "dataPresent": true
            }

+ Response 401

    [1161][]

+ Response 429

    [89][]

+ Response 400

    [1167][]


# Group Survey
Engage each customer at the right time with NPS or CSAT surveys to improve your service.

## Get [/v1/survey/{survey_id}{?businessId,lang}]
Get Survey fetches the survey designer page details for a particular survey. It provides all the questions which are available in the requested survey ID.

### Get Survey [GET]

+ Parameters
    + survey_id: 123 (integer, required) - Id of the Survey.
    + businessId: 12345678 (number, required) - Id of the Business.
    + lang: english (string, optional) - The survey locale, default is english



+ Request (application/json)

    + Headers

            Accept: application/json
            x-api-key: [Required] Partner specific API key provided by Birdeye for data exchange.

+ Response 200

    + Body

              {
                  "surveyId": 535,
                  "logoUrl": "https://d2xt3xymj142xp.cloudfront.net/145301531829695/logo%2F57db1409813c70.82884191.png",
                  "name": "JetBlue Customer Satisfaction Survey",
                  "status": "new",
                  "created": 1484941995000,
                  "lastModified": 1484941995000,
                  "responses": 0,
                  "questionCount": 4,
                  "pages": [
                      {
                          "name": "Introduction",
                          "id": 2316,
                          "order": 0,
                          "showQuestionNumbers": 1,
                          "visible": false,
                          "questions": [
                              {
                                  "title": "Thank you for traveling with JetBlue Airways! We’d love to hear about your recent trip with us.  Your feedback will help us improve the way we serve you",
                                  "name": "Question name",
                                  "showQuestionNumbers": 1,
                                  "id": 10315,
                                  "skipQuestion": false,
                                  "displayQuestion": false,
                                  "minimumValue": 0,
                                  "maximumValue": 0,
                                  "order": 0,
                                  "visible": true,
                                  "isRequired": true,
                                  "type": "label",
                                  "reactElementId": 493,
                                  "value": [],
                                  "choices": [],
                                  "rows": [],
                                  "skipLogic": [],
                                  "displayLogic": []
                              },
                              {
                                  "title": "How was your trip today",
                                  "name": "Question name",
                                  "showQuestionNumbers": 1,
                                  "id": 10314,
                                  "skipQuestion": false,
                                  "displayQuestion": false,
                                  "minimumValue": 0,
                                  "maximumValue": 0,
                                  "order": 1,
                                  "visible": true,
                                  "isRequired": true,
                                  "type": "radio",
                                  "reactElementId": 840,
                                  "value": [],
                                  "choices": [
                                      {
                                          "id": 22854,
                                          "title": "Satified",
                                          "order": 0
                                      },
                                      {
                                          "id": 22856,
                                          "title": "Needs Improvement",
                                          "order": 1
                                      },
                                      {
                                          "id": 22855,
                                          "title": "Dissatiffied",
                                          "order": 2
                                      }
                                  ],
                                  "rows": [],
                                  "skipLogic": [],
                                  "displayLogic": []
                              },
                              {
                                  "title": "Please rate us based on your experience",
                                  "name": "Question name",
                                  "showQuestionNumbers": 1,
                                  "id": 10316,
                                  "skipQuestion": false,
                                  "displayQuestion": false,
                                  "maximumRateDescription": "Excellent",
                                  "minimumRateDescription": "Poor",
                                  "minimumValue": 1,
                                  "maximumValue": 10,
                                  "order": 2,
                                  "visible": true,
                                  "isRequired": true,
                                  "type": "rating",
                                  "reactElementId": 101,
                                  "value": [],
                                  "choices": [],
                                  "rows": [],
                                  "skipLogic": [],
                                  "displayLogic": []
                              },
                              {
                                  "title": "Thanks for your feedback! Please let us know how we can serve you better",
                                  "name": "Question name",
                                  "showQuestionNumbers": 1,
                                  "id": 10317,
                                  "skipQuestion": false,
                                  "displayQuestion": false,
                                  "minimumValue": 0,
                                  "maximumValue": 0,
                                  "order": 3,
                                  "visible": true,
                                  "isRequired": true,
                                  "type": "textarea",
                                  "reactElementId": 813,
                                  "value": [],
                                  "choices": [],
                                  "rows": [],
                                  "skipLogic": [],
                                  "displayLogic": []
                              }
                          ]
                      }
                  ],
                  "supportedLocales": [],
                  "buttonTexts": [
                      {
                          "id": 2096,
                          "locale": "en",
                          "textKey": "Start",
                          "localeText": "Start"
                      },
                      {
                          "id": 2097,
                          "locale": "en",
                          "textKey": "Cancel",
                          "localeText": "Cancel"
                      },
                      {
                          "id": 2098,
                          "locale": "en",
                          "textKey": "Back",
                          "localeText": "Back"
                      },
                      {
                          "id": 2099,
                          "locale": "en",
                          "textKey": "Next",
                          "localeText": "Next"
                      },
                      {
                          "id": 2100,
                          "locale": "en",
                          "textKey": "Done",
                          "localeText": "Done"
                      },
                      {
                          "id": 2101,
                          "locale": "en",
                          "textKey": "Finish",
                          "localeText": "Finish"
                      },
                      {
                          "id": 2102,
                          "locale": "en",
                          "textKey": "Submit",
                          "localeText": "Submit"
                      },
                      {
                          "id": 2103,
                          "locale": "en",
                          "textKey": "notNow",
                          "localeText": "Not Now"
                      }
                  ],
                  "businessId": 145301531829695
              }

+ Response 400

    [1315][]

+ Response 404

    [1011][]

+ Response 401

    [1167][]

+ Response 400

    [1161][]

+ Response 429

    [89][]



## Submit [/v1/survey/{survey_id}/submit{?businessId}]
Post a survey response API submits the survey response for a particular survey using JSON structure.


### Post a survey response [POST]

+ Parameters
    + survey_id: 123 (integer, required) - Id of the Survey.
    + businessId: 12345678 (string, required) - Id of the Business.



+ Request (application/json)

    + Headers

            Accept: application/json
            x-api-key: [Required] Partner specific API key provided by Birdeye for data exchange.

    + Body

            {
                "surveyId": 535,
                "logoUrl": "https://d2xt3xymj142xp.cloudfront.net/145301531829695/logo%2F57db1409813c70.82884191.png",
                "name": "JetBlue Customer Satisfaction Survey",
                "status": "new",
              "created": 1484941995000,
              "lastModified": 1484941995000,
              "responses": 0,
              "questionCount": 4,
              "pages": [
                  {
                      "name": "Introduction",
                      "id": 2316,
                      "order": 0,
                      "showQuestionNumbers": 1,
                      "visible": false,
                      "questions": [
                          {
                              "title": "Thank you for traveling with JetBlue Airways! We’d love to hear about your recent trip with us.  Your feedback will help us improve the way we serve you",
                              "name": "Question name",
                              "showQuestionNumbers": 1,
                              "id": 10315,
                              "skipQuestion": false,
                              "displayQuestion": false,
                              "minimumValue": 0,
                              "maximumValue": 0,
                              "order": 0,
                              "visible": true,
                              "isRequired": true,
                              "type": "label",
                              "reactElementId": 493,
                              "value": [],
                              "choices": [],
                              "rows": [],
                              "skipLogic": [],
                              "displayLogic": []
                          },
                          {
                              "title": "How was your trip today",
                              "name": "Question name",
                              "showQuestionNumbers": 1,
                              "id": 10314,
                              "skipQuestion": false,
                              "displayQuestion": false,
                              "minimumValue": 0,
                              "maximumValue": 0,
                              "order": 1,
                              "visible": true,
                              "isRequired": true,
                              "type": "radio",
                              "reactElementId": 840,
                              "value": [
                                  "22856"
                              ],
                              "choices": [
                                  {
                                      "id": 22854,
                                      "title": "Satified",
                                      "order": 0
                                  },
                                  {
                                      "id": 22856,
                                      "title": "Needs Improvement",
                                      "order": 1
                                  },
                                  {
                                      "id": 22855,
                                      "title": "Dissatiffied",
                                      "order": 2
                                  }
                              ],
                              "rows": [],
                              "skipLogic": [],
                              "displayLogic": []
                          },
                          {
                              "title": "Please rate us based on your experience",
                              "name": "Question name",
                              "showQuestionNumbers": 1,
                              "id": 10316,
                              "skipQuestion": false,
                              "displayQuestion": false,
                              "maximumRateDescription": "Excellent",
                              "minimumRateDescription": "Poor",
                              "minimumValue": 1,
                              "maximumValue": 10,
                              "order": 2,
                              "visible": true,
                              "isRequired": true,
                              "type": "rating",
                              "reactElementId": 101,
                              "value": [
                                  "9"
                              ],
                              "choices": [],
                              "rows": [],
                              "skipLogic": [],
                              "displayLogic": []
                          },
                          {
                              "title": "Thanks for your feedback! Please let us know how we can serve you better",
                              "name": "Question name",
                              "showQuestionNumbers": 1,
                              "id": 10317,
                              "skipQuestion": false,
                              "displayQuestion": false,
                              "minimumValue": 0,
                              "maximumValue": 0,
                              "order": 3,
                              "visible": true,
                              "isRequired": true,
                              "type": "textarea",
                              "reactElementId": 813,
                              "value": [
                                  "I'm happy with the service! Wi-Fi can be better"
                              ],
                              "choices": [],
                              "rows": [],
                              "skipLogic": [],
                              "displayLogic": []
                          }
                      ]
                  }
              ],
              "businessId": 145301531829695,
              "isComplete":1
            }

+ Response 200

+ Response 400

  [1315][]

+ Response 401

  [1161][]

+ Response 429

  [89][]

+ Response 401

  [1167][]

+ Response 404

  [1011][]



## List Responses [/v1/survey/ext/list/responses/{survey_id}{?businessNumber,page,size,sortby,sorder,includeTicketId}]
List Responses for a Survey API fetches all the responses available for a particular survey ID.


### List Responses for a Survey [POST]

+ Parameters
    + survey_id: 123 (integer, required) - Id of the Survey.
    + businessNumber: 169744180007807 (string, required) - The Business Number of Enterprise
    + page: 0 (integer, optional) - The page number, starts with 0.
    + size: 30 (integer, optional) - The size of the page.
    + sortby: date (string, optional) - The sort by parameter.
    + sorder: asc (string, optional) - The sort order parameter.
    + includeTicketId: false (boolean, optional)  - The field to fetch ticketIds associated with the response.


+ Request (application/json)

    + Headers

            Accept: application/json
            x-api-key: [Required] Partner specific API key provided by Birdeye for data exchange.

    + Attributes
        + startDate: "MM/dd/yyyy HH:mm:ss" (string, optional) - Start date.
        + endDate: "MM/dd/yyyy HH:mm:ss" (string, optional) - End date.

    + Body

            {
                "startDate" : "07/03/2018 06:30:00",
                "endDate" : "07/23/2018 06:45:00"
            }




+ Response 200

    + Body

            {
               "responseList":[
                  {
                     "responseId":12345,
                     "requestDate":"07/11/2018",
                     "responseDate":"07/11/2018",
                     "completed":true,
                     "questionCount":10,
                     "locale":"en",
                     "surveyId":1000,
                     "surveyName":"Test Edit Test Edit 2(2)",
                     "locationName":"BMW",
                     "customerId":123456,
                     "customerName":"Anonymous",
                     "ticketed":false,
                     "ticketIds": [
                        100770,
                        100751
                      ],
                     "answers":[
                        {
                           "questionTitle":"We are interested in receiving your feedback. \nabout the care provided at our facility. \n\nPlease take a few minutes to rate your satisfaction with each of the following\n\nPlease describe ur properties.",
                           "questionType":"label",
                           "visible":true,
                           "conditional":false,
                           "shownToCustomer":true,
                           "hidden":false,
                           "maxValue":0,
                           "minValue":0,
                           "showTime":true,
                           "showDate":true
                        },
                        {
                           "questionTitle":"Single CHoice",
                           "questionType":"radio",
                           "visible":true,
                           "conditional":false,
                           "shownToCustomer":true,
                           "hidden":false,
                           "maxValue":0,
                           "minValue":0,
                           "showTime":true,
                           "showDate":true,
                           "answer":"A"
                        },
                        {
                           "questionTitle":"Multiple choice q",
                           "questionType":"checkbox",
                           "visible":true,
                           "conditional":false,
                           "shownToCustomer":true,
                           "hidden":false,
                           "maxValue":0,
                           "minValue":0,
                           "showTime":true,
                           "showDate":true,
                           "answer":"A"
                        },
                        {
                           "questionTitle":"Multiple Text Entry edited",
                           "questionType":"textarea",
                           "visible":true,
                           "conditional":false,
                           "shownToCustomer":true,
                           "hidden":false,
                           "maxValue":0,
                           "minValue":0,
                           "showTime":true,
                           "showDate":true,
                           "answer":"qwsad"
                        },
                        {
                           "questionTitle":"Single TExt Entry edited",
                           "questionType":"text",
                           "visible":true,
                           "conditional":false,
                           "shownToCustomer":true,
                           "hidden":false,
                           "maxValue":0,
                           "minValue":0,
                           "showTime":true,
                           "showDate":true,
                           "answer":"fasdf"
                        },
                        {
                           "questionTitle":"Drop Down edited",
                           "questionType":"dropdown",
                           "visible":true,
                           "conditional":false,
                           "shownToCustomer":true,
                           "hidden":false,
                           "maxValue":0,
                           "minValue":0,
                           "showTime":true,
                           "showDate":true,
                           "answer":"Select1"
                        },
                        {
                           "questionTitle":"Please rate us based on your experience Rating Question edited",
                           "questionType":"rating",
                           "visible":true,
                           "conditional":true,
                           "shownToCustomer":true,
                           "hidden":false,
                           "maxValue":10,
                           "minValue":1,
                           "showTime":true,
                           "showDate":true,
                           "answer":"6"
                        },
                        {
                           "questionTitle":"Please rate us for the below mentioned services Matrix Drop Down edited",
                           "questionType":"matrixdropdown",
                           "visible":true,
                           "conditional":false,
                           "shownToCustomer":true,
                           "hidden":false,
                           "maxValue":0,
                           "minValue":0,
                           "showTime":true,
                           "showDate":true,
                           "childAnswers":[
                              {
                                 "questionTitle":"Click to write statement 1",
                                 "questionType":"dropdown",
                                 "visible":true,
                                 "conditional":false,
                                 "shownToCustomer":true,
                                 "hidden":false,
                                 "maxValue":0,
                                 "minValue":0,
                                 "showTime":true,
                                 "showDate":true,
                                 "answer":"Choice 1"
                              },
                              {
                                 "questionTitle":"Click to write statement 2",
                                 "questionType":"dropdown",
                                 "visible":true,
                                 "conditional":false,
                                 "shownToCustomer":true,
                                 "hidden":false,
                                 "maxValue":0,
                                 "minValue":0,
                                 "showTime":true,
                                 "showDate":true,
                                 "answer":"Choice 1"
                              },
                              {
                                 "questionTitle":"Click to write statement 3",
                                 "questionType":"dropdown",
                                 "visible":true,
                                 "conditional":false,
                                 "shownToCustomer":true,
                                 "hidden":false,
                                 "maxValue":0,
                                 "minValue":0,
                                 "showTime":true,
                                 "showDate":true,
                                 "answer":"Choice 1"
                              },
                              {
                                 "questionTitle":"Click to write statement 4",
                                 "questionType":"dropdown",
                                 "visible":true,
                                 "conditional":false,
                                 "shownToCustomer":true,
                                 "hidden":false,
                                 "maxValue":0,
                                 "minValue":0,
                                 "showTime":true,
                                 "showDate":true,
                                 "answer":"Choice 2"
                              },
                              {
                                 "questionTitle":"Click to write statement 5",
                                 "questionType":"dropdown",
                                 "visible":true,
                                 "conditional":false,
                                 "shownToCustomer":true,
                                 "hidden":false,
                                 "maxValue":0,
                                 "minValue":0,
                                 "showTime":true,
                                 "showDate":true,
                                 "answer":"Choice 2"
                              },
                              {
                                 "questionTitle":"Click to write statement",
                                 "questionType":"dropdown",
                                 "visible":true,
                                 "conditional":false,
                                 "shownToCustomer":true,
                                 "hidden":false,
                                 "maxValue":0,
                                 "minValue":0,
                                 "showTime":true,
                                 "showDate":true,
                                 "answer":"Choice 2"
                              }
                           ]
                        },
                        {
                           "questionTitle":"How likely are you to recommend us to your family and friends NPS edited?",
                           "questionType":"nps",
                           "visible":true,
                           "conditional":false,
                           "shownToCustomer":true,
                           "hidden":false,
                           "maxValue":10,
                           "minValue":0,
                           "showTime":true,
                           "showDate":true,
                           "answer":"7"
                        },
                        {
                           "questionTitle":"Matrix Radio Choice editedf",
                           "questionType":"matrixradio",
                           "visible":true,
                           "conditional":false,
                           "shownToCustomer":true,
                           "hidden":false,
                           "maxValue":0,
                           "minValue":0,
                           "showTime":true,
                           "showDate":true,
                           "childAnswers":[
                              {
                                 "questionTitle":"Click to write statement A",
                                 "questionType":"radio",
                                 "visible":true,
                                 "conditional":false,
                                 "shownToCustomer":true,
                                 "hidden":false,
                                 "maxValue":0,
                                 "minValue":0,
                                 "showTime":true,
                                 "showDate":true,
                                 "answer":"Choice D"
                              }
                           ]
                        }
                     ],
                     "overallScore": "9.0",
                     "customParam":  {
                          "order Date": "2024-03-21 06:14:00",
                          "orderId": "52"
                     },
                     "extraParams": {
                         "facilityId": "38861",
                         "Integration Trigger": "Updated Rentals",
                         "Current balance due": "0.0000",
                         "Move In date": "12-19-2023"
                     }
                  }
               ],
               "totalResponses":1,
               "pageNo":0,
               "pageSize":1,
               "hasNext":true
            }

+ Response 400

  [1315][]

+ Response 401

  [1161][]

+ Response 429

  [89][]

+ Response 401

  [1167][]

+ Response 404

  [1011][]



## Get All [/v1/survey/business/{business_id}/all{?sortby,sorder,searchStr}]
Get All Surveys fetches the list of all available surveys on the business.

### Get All Surveys [GET]

+ Parameters

    + sortby: modified (string, optional) - Sort results by lastModified[modified], Created[created], Response Count[response].
    + sorder: 0 (string, optional) - Sort order ascending (0) and descending (1).
    + searchStr: abc (string, optional) - Search survey by name or business location.
    + business_id: 12345678 (string, required) - Business ID.


+ Request (application/json)

    + Headers

            Accept: application/json
            x-api-key: [Required] Partner specific API key provided by Birdeye for data exchange.

+ Response 200

    + Attributes (array)
        + (object)
            + surveyId: 1234 (number) - Survey Id.
            + name: JetBlue Customer Satisfaction Survey (string) - Survey Name.
            + status: new (string) - Survey status.
            + created: 1458844108000 (number) - Survey created date in epoc.
            + lastModified: 1482174350000 (number) - Survey last modified date in epoc
            + responses: 97 (number) - Number of survey responses.
            + questionCount: 13 (number) - Number of questions.


    + Body

            [{
                "surveyId": 9,
                "name": "JetBlue Customer Satisfaction Survey",
                "status": "new",
                "created": 1458844108000,
                "lastModified": 1482174350000,
                "responses": 97,
                "questionCount": 13
            },
            {
                "surveyId": 10,
                "name": "JetBlue Membership Survey",
                "status": "active",
                "created": 1481554022000,
                "lastModified": 1484867564000,
                "responses": 20,
                "questionCount": 18
            }
            ]



+ Response 404

    [1011][]

+ Response 401

    [1167][]

+ Response 400

    [1161][]

+ Response 429

    [89][]




## Create Survey [/v1/survey/external/create/{businessId}]
Create Survey API helps create a new survey for the required question structure and further displays it on the survey list page.

<b>Please go through <a href="https://bit.ly/3km4oJi">this document</a> for a detailed explanation of request body fields </b>

### Create Survey [POST]

+ Parameters

    + businessId: 12345678 (string, required) -Id of the Business.



+ Request (application/json)

    + Headers

            Accept: application/json
            x-api-key: [Required] Partner specific API key provided by Birdeye for data exchange.


    + Body

            {
                "surveyName": "Experience Survey",
                "thankYouMessage": "Thank you for taking the survey!",
                "surveyType": "traditional",
                "ownerEmailId": "testmail@gmail.com",
                "pages": [
                    {
                        "questions": [
                            {
                                "title": "Text1",
                                "type": "text"
                            },
                            {
                                "title": "Paragraph",
                                "type": "textarea"
                            }
                        ]
                    },
                    {
                        "title": "Page 2-optional",
                        "questions": [
                            {
                                "title": "Questionnumber1",
                                "type": "checkbox",
                                "required": true,
                                "choices": [
                                    "Choice 1",
                                    "Choice 2",
                                    "Choice 3"
                                ]
                            },
                            {
                                "title": "Q2",
                                "type": "dropdown",
                                "choices": [
                                    "Dropdown 1",
                                    "Dropdown 2",
                                    "Dropdown 3"
                                ]
                            },
                            {
                                "title": "ratingQn",
                                "type": "rating",
                                "minLabel": "Strongly Disagree",
                                "maxLabel": "Strongly Agree",
                                "maxValue": 10
                            }
                        ]
                    },
                    {
                        "questions": [
                            {
                                "title": "P3-Q1-Radio",
                                "type": "radio",
                                "choices": [
                                    "radio 1",
                                    "radio 2",
                                    "radio 3"
                                ]
                            },
                            {
                                "title": "npsQn",
                                "type": "nps",
                                "minLabel": "Strongly Disagree"
                            }
                        ]
                    },
                    {
                        "questions": [
                            {
                                "title": "Datetime question",
                                "type": "datetime",
                                "required": true,
                                "showTime": true,
                                "showDate": true,
                                "interval": 60,
                                "minValue": "12",
                                "maxValue": "36"
                            },
                            {
                                "title": "Please enter your contact information",
                                "type": "contact",
                                "required": true,
                                "contactRows": [
                                    {
                                        "required": true,
                                        "title": "First name",
                                        "type": "text"
                                    },
                                    {
                                        "required": true,
                                        "title": "Email",
                                        "type": "email"
                                    },
                                    {
                                        "required": true,
                                        "title": "Phone",
                                        "type": "phone"
                                    }
                                ]
                            }
                        ]
                    },
                    {
                        "title": "Page 4",
                        "questions": [
                            {
                                "title": "P4-Q1",
                                "type": "matrixrating",
                                "minLabel": "Strongly Disagree",
                                "maxLabel": "Strongly Agree",
                                "maxValue": 5,
                                "rows": [
                                    "Row label 1",
                                    "Row label 2"
                                ]
                            },
                            {
                                "title": "P4-Q2",
                                "type": "matrixradio",
                                "required": true,
                                "choices": [
                                    "c1",
                                    "c2",
                                    "c3"
                                ],
                                "rows": [
                                    "Row 1",
                                    "Row2"
                                ]
                            },
                            {
                                "title": "p4-Q3",
                                "type": "matrixdropdown",
                                "required": true,
                                "choices": [
                                    "c1",
                                    "c2",
                                    "c3"
                                ],
                                "rows": [
                                    "Row label 1",
                                    "Row label 2"
                                ]
                            },
                            {
                                "title": "Label type ques",
                                "type": "label"
                            }
                        ]
                    },
                    {
                        "questions": [
                            {
                                "title": "please review us on one of these sites",
                                "type": "review",
                                "required": true,
                                "contactUsMessage": "ContactUs test message",
                                "reviewSources": ["Google","Facebook","CitySearch"
                                ]
                            }
                        ]
                    }
                ]
            }

+ Response 200

    + Body

              {
                  "surveyId": 1234
              }


+ Response 401

    [1161][]

+ Response 401

    [1380][]

+ Response 429

    [89][]

+ Response 404

    [1011][]

+ Response 400

    [2044][]

+ Response 400

    [2093][]

+ Response 400

    [2045][]

+ Response 400

    [2046][]

+ Response 400

    [2047][]

+ Response 400

    [2048][]

+ Response 400

    [2049][]

+ Response 400

    [2050][]

+ Response 400

    [2051][]

+ Response 400

    [2052][]

+ Response 400

    [2053][]

+ Response 400

    [2054][]

+ Response 400

    [2055][]

+ Response 400

    [2056][]

+ Response 400

    [2057][]

+ Response 400

    [2058][]

+ Response 400

    [2059][]

+ Response 400

    [2060][]

+ Response 400

    [2061][]

+ Response 400

    [2062][]

+ Response 400

    [2063][]

+ Response 400

    [2064][]

+ Response 400

    [2065][]

+ Response 400

    [2066][]

+ Response 400

    [2067][]

+ Response 400

    [2068][]

+ Response 400

    [2069][]

+ Response 400

    [2070][]

+ Response 400

    [2071][]

+ Response 400

    [2072][]

+ Response 400

    [2073][]

+ Response 400

    [2074][]

+ Response 400

    [2092][]

+ Response 400

    [2076][]

+ Response 400

    [2077][]

+ Response 400

    [2091][]

+ Response 400

    [2079][]

+ Response 400

    [2080][]

+ Response 400

    [2081][]

+ Response 400

    [2082][]

+ Response 400

    [2083][]

+ Response 400

    [2084][]

+ Response 400

    [2085][]

+ Response 400

    [2086][]

+ Response 400

    [2087][]

+ Response 400

    [2088][]

+ Response 400

    [2094][]

+ Response 400

    [2095][]




## Update Settings [/v1/survey/{surveyId}/settings/update{?businessId}]
Update Survey Settings helps update the survey page appearance settings like Logo, Title, ProgessBar setting, Theme Colour, User Acess, and many more.


> __Note__
> - _In user-access request, if multiple entries are detected for a user, they will be assigned the highest role among all the different roles specified. If the entries are conflicting (e.g. delete + update), the API will return with exception_


### Update Survey Settings [POST]

+ Parameters

    + surveyId: 123 (integer, required) - Survey ID
    + businessId: 12345678 (string, required) - Id of the Business.



+ Request (application/json)

    + Headers

            Accept: application/json
            x-api-key: [Required] Partner specific API key provided by Birdeye for data exchange.

    + Attributes

        + surveySettings (object) - Survey settings
            + showSurveyTitle: false (boolean) - Pass true if want to show survey title.
            + showQuestionNumber: false (boolean) - Pass true if want to show question number.
            + showProgressBar: false (boolean) - Pass true if want to show progress bar.
            + progressbarPosition: Bottom (string) - Position of progress bar.
            + showLogo: ON (string) - Pass ON if want to show logo.
            + showTitle: CUSTOM (string) - Show title.
            + customTitle: Welcome to Tennessee (string) - Custom title value.
            + themeColor: #1976d2 (string) - Theme color value.
            + themeTextColor: #ffffff (string) - Theme color text value.
            + subject: Thank you for taking the survey (string) - Subject of the survey email.
            + message: Thank you for taking the time to give your inputs on the survey (string) - Thank you message..
            + signature: Sincerely, BMW_Survey (string) - Signature.
            + enableThankyouEmail: false (boolean) - Pass true if want to enable Thank you email.
        + accessControl (object) - Access control data.
            + userAccessList (array)
                + (object)
                    + userEmail: abc@test.com (string) - Email of the user.
                    + role: viewer (string) - User role.
                    + delete: true (boolean) - Delete status of the user.
            + surveyAccess (object)
                + role: editor - User's survey access.

    + Body

            {
                "surveySettings": {
                    "showSurveyTitle": false,
                    "showQuestionNumber": false,
                    "showProgressBar": false,
                    "progressbarPosition": "Bottom",
                    "showLogo": "ON",
                    "showTitle": "CUSTOM",
                    "customTitle": "Welcome to Tennessee!",
                    "themeColor": "#1976d2",
                    "themeTextColor": "#ffffff",
                    "subject": "Thank you for taking the survey",
                    "message": "Hi , \nThank you for taking the time to give your inputs on the survey.",
                    "signature": "Sincerely, \nBMW_Survey \n",
                    "enableThankyouEmail": true
                },
                "accessControl": {
                "userAccessList": [
                  {
                    "userEmail": "abc@test.com",
                    "role": "viewer"
                  },
                  {
                    "userEmail": "def@test.com",
                    "delete" : true
                  }
                ],
              "surveyAccess": {
                        "role": "editor"
                    }
                }
            }

+ Response 200

    + Body

              {
                  "surveyId": 1234,
                  "suveySettingId" : 12345
              }


+ Response 401

    [1380][]

+ Response 404

    [1161][]

+ Response 401

    [89][]

+ Response 400

    [1011][]

+ Response 404

    [1175][]

+ Response 400

    [1315][]

+ Response 400

    [2037][]

+ Response 400

    [2042][]

+ Response 400

    [2040][]

+ Response 400

    [2090][]

+ Response 400

    [2043][]

+ Response 400

    [2039][]

+ Response 400

    [2038][]

+ Response 400

    [2041][]

+ Response 400

    [2096][]

# Group Business Media
Add, delete and manage business media.

> __Supported Media Size__
> - _Photo: JPG or PNG. 720 x 720px. 10KB min._
> - _Video: 30 sec long. 720p or more upto 75MB._

> __Note__
> - _Uploaded media will be pushed to your google business profile (if connected) and other long tail directories only._



## Add Media [/v1/business/{businessNumber}/upload/media]
API to upload the Business Media.


### Add Media [POST]

+ Parameters

    + businessNumber: 169744180007807 (string, required) - Location Number, in case of SMB it will be Business Number.


+ Request (application/json)

    + Headers

            Accept: application/json
            x-api-key: [Required] Partner specific API key provided by Birdeye for data exchange.


    + Attributes
        + media (required, array) - List of media items to be uploaded.
            + (object)
                + url: https://images.pexels.com/photos/12128533/pexelsphoto12128533.jpeg (string, required) - Url of the media item.
                + mediaCategory: TEAMS (string, required) - Category for the media item. Possible values are:
                                        EXTERIOR (PHOTO, VIDEO)
                                        INTERIOR (PHOTO, VIDEO)
                                        TEAMS (PHOTO, VIDEO)
                                        ADDITIONAL (PHOTO, VIDEO)
                + description: Image of the team (string, required) - Description of the media.
                + mediaFormat: PHOTO (string, required) - Format of the Media. Possible values are:
                                                    PHOTO
                                                    VIDEO



    + Body

            {
                "media": [
                {
                    "url": "https://images.pexels.com/photos/12128533/pexels-photo-12128533.jpeg?auto=compress&cs=tinysrgb&w=1260&h=750&dpr=2",
                    "mediaCategory": "TEAMS",
                    "description": "Image of the team",
                    "mediaFormat": "PHOTO"
                },
                {
                    "url": "https://videos.pexels.com/video/123123/pexelsvideo-12323.mp4",
                    "mediaCategory": "ADDITIONAL",
                    "description": "Introductory video",
                    "mediaFormat": "VIDEO"
                }
                ]
            }

+ Response 200


    + Attributes
        + media (required, array) - List of media items.
            + (object)
                + mediaId: 987654321123 (string) - Id of the media.
                + url: https://images.pexels.com/photos/12128533/pexelsphoto12128533.jpeg (string) - Url of the media item.
                + mediaCategory: TEAMS (string) - Category for the media item.
                + description: Image of the team (string) - Description of the media.
                + mediaFormat: PHOTO (string) - Format of the Media.


    + Body

            {
                "media": [
                {
                    "mediaId": "987654321123",
                    "url": "https://images.pexels.com/photos/12128533/pexels-photo-12128533.jpeg?auto=compress&cs=tinysrgb&w=1260&h=750&dpr=2",
                    "mediaCategory": "TEAMS",
                    "description": "Image of the team",
                    "mediaFormat": "PHOTO"
                },
                {
                    "mediaId": "7654321123",
                    "url": "https://videos.pexels.com/video/123123/pexelsvideo-12323.mp4",
                    "mediaCategory": "ADDITIONAL",
                    "description": "Introductory video",
                    "mediaFormat": "VIDEO"
                }
                ]
            }


+ Response 401

    [1011][]

+ Response 401

    [1161][]

+ Response 401

    [1167][]

+ Response 429

    [89][]

+ Response 400

    [2174][]

+ Response 400

    [2180][]

+ Response 400

    [2181][]

+ Response 400

    [2171][]

+ Response 400

    [2175][]



## Get Media [/v1/business/{businessNumber}/media/get]
API to get the Business Media details.

### Get Media [GET]

+ Parameters

    + businessNumber: 169744180007807 (string, required) - Location Number, in case of SMB it will be Business Number.


+ Request (application/json)

    + Headers

            Accept: application/json
            x-api-key: [Required] Partner specific API key provided by Birdeye for data exchange.


+ Response 200


    + Attributes
        + media (array) - List of media items of the business.
            + (object)
                + mediaId: 987654321123 (string) - Id of the media.
                + url: https://images.pexels.com/photos/12128533/pexelsphoto12128533.jpeg (string) - Url of the media item.
                + mediaCategory: TEAMS (string) - Category for the media item.
                + description: Image of the team (string) - Description of the media.
                + mediaFormat: PHOTO (string) - Format of the Media.


    + Body

            {
                "media": [
                {
                    "mediaId": "987654321123",
                    "url": "https://images.pexels.com/photos/12128533/pexels-photo-12128533.jpeg?auto=compress&cs=tinysrgb&w=1260&h=750&dpr=2",
                    "mediaCategory": "TEAMS",
                    "description": "Image of the team",
                    "mediaFormat": "PHOTO"
                },
                {
                    "mediaId": "7654321122",
                    "url": "https://videos.pexels.com/video/123123/pexelsvideo-12323.mp4",
                    "mediaCategory": "ADDITIONAL",
                    "description": "Introductory video",
                    "mediaFormat": "VIDEO"
                }
                ]
            }


+ Response 401

    [1011][]

+ Response 401

    [1161][]

+ Response 401

    [1167][]

+ Response 429

    [89][]


## Update Media [/v1/business/{businessNumber}/update/media/{mediaId}]
API to update the Business Media.

### Update Media [PUT]

+ Parameters

    + businessNumber: 169744180007807 (string, required) - Location Number, in case of SMB it will be Business Number.
    + mediaId: 62185029212 (string, required) - Id of the media item.


+ Request (application/json)

    + Headers

            Accept: application/json
            x-api-key: [Required] Partner specific API key provided by Birdeye for data exchange.


    + Attributes
        + mediaCategory: INTERIOR (string, required) - Category for the media item. Possible values are:
                                                                EXTERIOR
                                                                INTERIOR
                                                                TEAMS
                                                                ADDITIONAL



    + Body

            {
                "mediaCategory": "INTERIOR"
            }

+ Response 200


+ Response 401

    [1161][]

+ Response 401

    [1167][]

+ Response 429

    [89][]

+ Response 400

    [2174][]

+ Response 400

    [2270][]

+ Response 400

    [2176][]

+ Response 400

    [2177][]



## Delete Media [/v1/business/{businessNumber}/media/delete]
API to delete the Business Medias.

### Delete Media [DELETE]

+ Parameters

    + businessNumber: 169744180007807 (string, required) - Location Number, in case of SMB it will be Business Number.


+ Request (application/json)

    + Headers

            Accept: application/json
            x-api-key: [Required] Partner specific API key provided by Birdeye for data exchange.


    + Attributes
        + mediaIds: 123456,654321 (array, required) - List of Media Ids to be deleted.


    + Body

            {
                "mediaIds": ["987654321123","7654321123"]
            }

+ Response 200


+ Response 401

    [1011][]

+ Response 401

    [1161][]

+ Response 401

    [1167][]

+ Response 429

    [89][]

+ Response 400

    [2177][]


# Group Social
Create and track Social posting for all channels.

## Schedule Social Post [/v1/social/{accountNumber}/schedule]
This API allows users to schedule or immediately post content on supported social sites. Users can specify the content, media, and schedule a specific time for the post. Supported social sites include Google Business Profile, Facebook, Instagram, LinkedIn, and Twitter.

### Schedule Social Post [POST]

+ Parameters

    + accountNumber: 12345678 (number, required) - Id of the Account.

+ Request (application/json)

    + Headers

            Accept: application/json
            x-api-key: [Required] Partner specific API key provided by Birdeye for data exchange.


    + Attributes
        + text: Check out the latest collection (string, required) - Input text that will be added in the post. Limits of characters across various Social Sites
                            Google Business Profile: 1500
                            Facebook: 5000
                            Instagram: 5000
                            LinkedIn: 3000
                            Twitter: 240
        + socialSite: TWITTER (string, required) - The social site where the post will be made. Possible values are
                            INSTAGRAM,
                            FACEBOOK,
                            GOOGLEMYBUSINESS,
                            LINKEDIN,
                            TWITTER
            + Error message: Input SocialSite does not match with any one of the SOCIAL SITE (TWITTER,FACEBOOK, GOOGLEMYBUSINESS,LINKEDIN,INSTAGRAM)
        + subBusinessNumbers: 123456780,123456781 (array) - List of Location Ids. Optional for SMB.
        + scheduleTimestamp: 1677759962528 (number) - A Unix timestamp in milliseconds that represents the date and time when the post should be scheduled. If not provided, the post will be published after 5 minutes of posting.
        + media (object) - Media details.
            + type: IMAGE (string) - An array of media objects, each containing the media type and the URL. Allowed media type are IMAGE, VIDEO and REEL.
            + mediaUrl: https://upload.wikimedia.org/wikipedia/commons/5/53/Google_Logo.png (string) - Media Link.
            + Error message: Input Media Type does not match with any one of the MEDIA TYPE.
        + additionalMetaData (object) - Additional metadata for the post, including a call to action (CTA). Applicable only for GOOGLEMYBUSINESS.
            + callToActionType: LEARN_MORE, BOOK, ORDER, SHOP, SIGN_UP, CALL (string) - Type of data.
            + callToActionUrl: https://app.birdeye.com (string) - Link of the additional data(Not required when CTA type is CALL).



    + Body

            {
                "text": "Check out the latest collection",
                "socialSite" : "GOOGLEMYBUSINESS" ,
                "subBusinessNumbers": [123456780,123456781],
                "scheduleTimestamp": 1677759962528,
                "media": [{
                    "type": "IMAGE",
                    "mediaUrl": "https://upload.wikimedia.org/wikipedia/commons/5/53/Google_Logo.png"
                },
                {
                    "type": "IMAGE",
                    "mediaUrl": "https://upload.wikimedia.org/wikipedia/commons/5/53/Google_Logo.png"
                }],
                "additionalMetaData": {
                "callToActionType":"LEARN_MORE",
                "callToActionUrl": "https://app.birdeye.com/"
                }
            }



+ Response 401

    [1161][]

+ Response 429

    [89][]

+ Response 401

    [1167][]

+ Response 404

    [1011][]

+ Response 400

    [5556][]

+ Response 400

    [5557][]


## Edit scheduled Social Post [/v1/social/post/public/scheduled/edit/{accountNumber}]
This api will edit a scheduled post created through public api. Users can specify the content, media, and schedule a specific time for the post. Supported social sites include Google Business Profile, Facebook, Instagram and LinkedIn.
If extra locations are included in subBusinessNumbers, the post will also be scheduled for those locations. If subBusinessNumbers now contains fewer locations than before, the post will be unscheduled from any locations that are no longer listed.
### Edit Scheduled Social Post [POST]

+ Parameters

    + accountNumber: 12345678 (number, required) - Id of the Account.

+ Request (application/json)

    + Headers

            Accept: application/json
            x-api-key: [Required] Partner specific API key provided by Birdeye for data exchange.


    + Attributes
        + trackingId: 4ece211b82162d1101d2d82a24876a92 (string, required) - Tracking id received when post was created through public api.
        + text: Check out the latest collection (string, required) - Input text that will be added in the post. Limits of characters across various Social Sites
                            Google Business Profile: 1500
                            Facebook: 5000
                            Instagram: 5000
                            LinkedIn: 3000
        + socialSite: LINKEDIN (string, required) - The social site where the post will be edited. Possible values are
                            INSTAGRAM,
                            FACEBOOK,
                            GOOGLEMYBUSINESS,
                            LINKEDIN
            + Error message: Input SocialSite does not match with any one of the SOCIAL SITE (FACEBOOK, GOOGLEMYBUSINESS,LINKEDIN,INSTAGRAM)
        + subBusinessNumbers: 123456780,123456781 (array, required) - List of location ids for which this post should be edited.
        + scheduleTimestamp: 1677759962528 (number) - A Unix timestamp in milliseconds that represents the date and time when the post should be scheduled. If not provided, the post will have same schedule time as the original one.
        + media (object) - Media details.
            + type: IMAGE (string) - An array of media objects, each containing the media type and the URL. Allowed media type are IMAGE, VIDEO and REEL.
            + mediaUrl: https://upload.wikimedia.org/wikipedia/commons/5/53/Google_Logo.png (string) - Media Link.
            + Error message: Input Media Type does not match with any one of the MEDIA TYPE.
        + additionalMetaData (object) - Additional metadata for the post, including a call to action (CTA). Applicable only for GOOGLEMYBUSINESS.
            + callToActionType: LEARN_MORE, BOOK, ORDER, SHOP, SIGN_UP, CALL (string) - Type of data.
            + callToActionUrl: https://app.birdeye.com (string) - Link of the additional data(Not required when CTA type is CALL).



    + Body

            {
                "trackingId": "4ece211b82162d1101d2d82a24876a92",
                "text": "Check out the latest collection",
                "socialSite" : "GOOGLEMYBUSINESS" ,
                "subBusinessNumbers": [123456780,123456781],
                "scheduleTimestamp": 1677759962528,
                "media": [{
                    "type": "IMAGE",
                    "mediaUrl": "https://upload.wikimedia.org/wikipedia/commons/5/53/Google_Logo.png"
                },
                {
                    "type": "IMAGE",
                    "mediaUrl": "https://upload.wikimedia.org/wikipedia/commons/5/53/Google_Logo.png"
                }],
                "additionalMetaData": {
                "callToActionType":"LEARN_MORE",
                "callToActionUrl": "https://app.birdeye.com/"
                }
            }



+ Response 401

    [1161][]

+ Response 429

    [89][]

+ Response 401

    [1167][]

+ Response 404

    [1011][]

+ Response 400

    [5556][]

+ Response 400

    [5557][]



## Edit published social Post [/v1/social/post/public/published/edit/{accountNumber}]
This api will edit a published post created through public api. Only text can be updated for a published post. Editing published post is only supported for these channels: Facebook, Google and LinedIn.

### Edit Published social Post [POST]

+ Parameters

    + accountNumber: 12345678 (number, required) - Id of the Account.

+ Request (application/json)

    + Headers

            Accept: application/json
            x-api-key: [Required] Partner specific API key provided by Birdeye for data exchange.


    + Attributes
        + trackingId: 4ece211b82162d1101d2d82a24876a92 (string, required) - Tracking id received when post was created through public api.
        + text: Check out the latest collection (string, required) - Text to be updated for the post. Limits of characters across various Social Sites
                            Google Business Profile: 1500
                            Facebook: 5000
                            LinkedIn: 3000
        + socialSite: LINKEDIN (string, required) - The social site where the post will be edited. Possible values are
                            FACEBOOK,
                            GOOGLEMYBUSINESS,
                            LINKEDIN
            + Error message: Input SocialSite does not match with any one of the SOCIAL SITE (FACEBOOK, GOOGLEMYBUSINESS,LINKEDIN)
        + subBusinessNumbers: 123456780,123456781 (array, required) - List of location ids for which this post should be edited. If list contains a location which is not part of the post, then no action will be taken for that location.

    + Body

            {
                "trackingId": "4ece211b82162d1101d2d82a24876a92",
                "text": "Check out the latest collection",
                "socialSite" : "GOOGLEMYBUSINESS" ,
                "subBusinessNumbers": [123456780,123456781]
            }



+ Response 401

    [1161][]

+ Response 429

    [89][]

+ Response 401

    [1167][]

+ Response 404

    [1011][]

+ Response 400

    [5556][]

+ Response 400

    [5557][]


## Delete public social Post [/v1/social/post/public/delete/{accountNumber}]
This api will delete a post created through public api. It can delete both scheduled and published posts. Deleting published post is only supported for these channels: Facebook, Google, LinedIn
### Delete public social Post [POST]


+ Parameters

    + accountNumber: 12345678 (number, required) - Id of the Account.

+ Request (application/json)

    + Headers

            Accept: application/json
            x-api-key: [Required] Partner specific API key provided by Birdeye for data exchange.


    + Attributes
        + trackingId: 4ece211b82162d1101d2d82a24876a92 (string, required) - Tracking id received when post was created through public api.
        + subBusinessNumbers: 123456780,123456781 (array, required) - List of location ids for which this post should be deleted. If list contains a location which is not part of the post, then no action will be taken for that location.

    + Body

            {
                "trackingId": "4ece211b82162d1101d2d82a24876a92",
                "subBusinessNumbers": [123456780,123456781]
            }



+ Response 401

    [1161][]

+ Response 429

    [89][]

+ Response 401

    [1167][]

+ Response 404

    [1011][]

+ Response 400

    [5556][]

+ Response 400

    [5557][]




## Track Social Post [/v1/social/{accountNumber}/post/track/{trackingId}]
This API allows users to track the status of a social post that was previously scheduled or published using the Schedule Social Post API. By providing the trackingId from the response of the scheduling API, users can query the status and details of the post across different social sites.

### Track Social Post [GET]

+ Parameters

    + accountNumber: 12345678 (number, required) - Id of the Account.
    + trackingId: abcdefdhs (string, required) - The tracking ID to track the status of the post.
        + Error message: Tracking Id not present in System

+ Request (application/json)

    + Headers

            Accept: application/json
            x-api-key: [Required] Partner specific API key provided by Birdeye for data exchange.


+ Response 200 (application/json)

    + Attributes
        + trackingId: BvgqPRWtObg4jWTKG2wHBg (string) -  The tracking ID of the scheduled or posted social post.
        + accountNumber: 124356718987 (string) -  The account ID associated with the post.
        + socialSite: TWITTER (string) - Social Sites. Possible values are
                            INSTAGRAM,
                            FACEBOOK,
                            GOOGLEMYBUSINESS,
                            LINKEDIN,
                            TWITTER
        + subBusinessNumbers: 123456780,123456781 (array) - List of Location Ids. Optional for SMB.
        + socialPostDetails (array) - An array of objects containing post details, including status, location name, and published timestamp.
            + (object)
                + locationName: Chalker and Peterson (string) - The name of the location where the post was published.
                + locationNumber: 12345678909 (string) - The ID of the location where the post was published.
                + status (object) - Post status details.
                    + status: POST_SUCCEEDED (string) - Post status. Possible values:
                                                                POST_SCHEDULED,
                                                                POST_SUCCEEDED,
                                                                POST_PROCESSING,
                                                                POST_FAILED,
                                                                REJECTED_BY_APPROVER
                    + failureReason: Your session has expired. Please log back into your Facebook account to continue. (string) - Failure reason if any.
                + publishedTimestamp: 43412413412 (number) - The Unix timestamp (in milliseconds) when the post was published.
                + socialSitePostId: 847803613041846_899791936843015 (string) - Social site post id.
                + socialSitePostUrl: http://www.facebook.com/847803613041846_899791936843015 (string) - Social site post link.



    + Body

            {
                    "trackingId": "BvgqPRWtObg4jWTKG2wHBg",
                    "accountNumber": 124356718987,
                    "socialSite" : "FACEBOOK"
                    "subBusinessNumbers": [123456780,123456781],
                    "socialPostDetails": [
                    {
                        "locationName": "Chalker and Peterson",
                        "locationNumber": 12345678909 ,
                        "status":{
                            "status": POST_SCHEDULED
                        },
                        "publishedTimestamp":  1679888791000
                    },
                    {
                        "locationName": "Prince George, BC",
                        "locationNumber": 2234561212 ,
                        "status":{
                            "status": POST_FAILED,
                            "failureReason": "Your session has expired. Please log back into your Facebook account to continue."
                        },
                        "publishedTimestamp": 43412413412
                    },
                    {
                        "locationName": "New York, NY",
                        "locationNumber": 323456121 ,
                        "status":{
                            "status": POST_SUCCEEDED
                        },
                        "publishedTimestamp": 43412413412,
                        "socialSitePostId": 847803613041846_899791936843015
                        "socialSitePostUrl": "http://www.facebook.com/847803613041846_899791936843015"
                    }]
                }



+ Response 401

    [1161][]

+ Response 429

    [89][]

+ Response 401

    [1167][]

+ Response 404

    [1011][]



# Group Employee


## Get [/v1/employee/{businessId}]
Get details of Employees is a lite version API that retrieves a sorted list of all active employees for an account.


### Get details of Employees [GET]

+ Parameters

    + businessId: 12345678 (string, required) - Id of the Business.



+ Request (application/json)

    + Headers

            Accept: application/json
            x-api-key: [Required] Partner specific API key provided by Birdeye for data exchange.

+ Response 200 (application/json)

    + Attributes (array)
        + (object)
            + firstName: Ron (string) - First name of the employee.
            + lastName: Smith (string) - Last name of the employee.
            + emailId: ron@test.com (string) - Email Id of the employee.
            + phone: 1234567890 (string) - Phone number of the employee.
            + imageUrl: employees/574549fb79cff9.54677638.jpg (string) - Image URL of the employee.


    + Body

            [
                {
                    "firstName": "sachin",
                    "lastName": "birdeye",
                    "emailId": "sachin@birdeye.com",
                    "phone": "",
                    "imageUrl": ""
                },
                {
                    "firstName": "Kailash",
                    "lastName": "Yadav",
                    "emailId": "kailash12121@gmail.com",
                    "phone": "(989) 898-9898",
                    "imageUrl": "employees/574549fb79cff9.54677638.jpg"
                },
                {
                    "firstName": "Kailash",
                    "lastName": "Yadav",
                    "emailId": "1213@gmail.com",
                    "phone": "(989) 898-9898",
                    "imageUrl": "http://d2xt3xymj142xp.cloudfront.net/169830616/573db5844e0e66.08202399.png"
                }
            ]

+ Response 401

    [1161][]

+ Response 429

    [89][]

+ Response 401

    [1167][]

+ Response 404

    [1011][]




# Group Conversation
Connect with customers across a range of digital channels from one unified inbox.


## List Conversations [/v1/messenger/export]
List Conversations retrieves conversations for a business.


### List Conversations [POST]


+ Request (application/json)

    + Attributes
        + businessNumber: 169744180007807 (number, required) - The business number for which the details to be fetched, it can be either enterprise or location business number.
        + apiKey: abcdefgh (string, required) -  Partner specific API key provided by Birdeye for data exchange.
        + startDate: 04/06/2020 (string) - Start fetching messages from this date in MM/DD/YYYY format.
        + endDate: 05/30/2020 (string) - Fetch messages till this date in MM/DD/YYYY format.
        + offset: 0 (number) - Message offset,the start index.
        + size: 100 (number) - Number of messages return in the response.
        + contact  (object) - Contact details
            + phone: 1234567890 (string) - Phone number of the contact.
            + email: tushar.garg@birdeye.com (string) - Email Id of the contact.
        + excludeCampaignMessages: 1 (number) - If passed with value 1, It will exclude campaign messages from API response.


    + Body

            {
                "businessNumber": "755009344",
                "apiKey": "abcdefgh",
                "startDate": "04/06/2020",
                "endDate": "05/30/2020",
                "offset": "0",
                "size": "100",
                "contact": {
                    "phone" : "(650)492-3456",
                    "email" : "abc@test.com"
                },
                "excludeCampaignMessages": 1
            }


+ Response 200 (application/json)

    + Attributes
        + totalConversations: 120 (number) - The number of total conversation objects that can be retrieved through pagination.
        + totalMessages: 1212 (string) -  The number of total message objects that can be retrieved through pagination.
        + conversations (array) - List of conversations.
            + (object)
                + id: 123 (string) - A unique ID generated by the Birdeye platform that identifies this conversation.
                + contact (object) - Contact details.
                    + id: 100 (number) - Contact id.
                    + name: Ron Smith (string) - Contact name.
                    + firstName: Ron (string) - Contact first name.
                    + lastName: Smith (string) - Contact last name.
                    + phone: 1234567890  (string) - Phone number of the contact.
                    + emailId: ron@test.com (string) - Email Id of the contact.
                    + createdDate: 2020-05-04 17:20:14 (string) - Contact creation date.
                    + updatedDate:  2021-05-04 17:20:14 (string) - Contact updation date.
                    + team: Blue (string) - Team name.
                    + locationId: 123445521 (string) - Location Id to which contact is attached.
                + messages (array) - List of messages.
                    + (object)
                        + sentAt: 1588612840000 (number) - Epoc time of the message.
                        + id: 1221  (number) - Message id.
                        + text: Great service (string) - Message text.
                        + attachments (object) - Attachment details.
                        + direction: SEND (string) - Message direction, SEND or RECEIVE.
                        + channel: LIVE_CHAT (string) - A unique identifier that is used to send or receive the message.for example: sms, email or Live_chat.
                + conversation_start_date: May 04, 2020 10:20 AM PDT (string) - The date conversation.
                + last_message_received_on: May 04, 2020 10:20 AM PDT (string) - The date on which the last message was recieved within the defined date range.
                + status: OPEN (string) - Status of the conversation, OPEN or CLOSE.
                + last_used_channel: SMS (string) - Last used channel.
                + assigned_to (object) - Assinee details.
                    + id: 100 (number) - Id of the user.
                    + name: Joe R (string) - Name of the Assignee.
                    + type: T (string) - Type of Assignee.
                    + emailId: joe@test.com (string) - Email id of Assignee.
        + hasMore: true (boolean) - Indicates if there are more conversations.



    + Body

            {
                "totalConversations": 1,
                "totalMessages": 2,
                "conversations": [
                    {
                        "id": 127490,
                        "contact": {
                            "id": 80768826,
                            "name": "S G",
                            "firstName": "S",
                            "lastName": "G",
                            "phone": "(650) 492-3456",
                            "emailId": null,
                            "createdDate": "2020-05-04 17:20:14",
                            "updatedDate": "2020-05-18 15:22:57",
                            "team": "Harshit",
                            "locationId": 155911960965004
                        },
                        "messages": [
                            {
                                "sentAt": 1588612840000,
                                "id": "124776",
                                "text": "hi",
                                "message_date": "May 04, 2020 10:20 AM PDT",
                                "attachments": null,
                                "direction": "SEND",
                                "channel": "SMS"
                            },
                            {
                                "sentAt": 1588612814000,
                                "id": "124775",
                                "text": "Hello",
                                "message_date": "May 04, 2020 10:20 AM PDT",
                                "attachments": null,
                                "direction": "RECEIVE",
                                "channel": "LIVE_CHAT"
                            }
                        ],
                        "conversation_start_date": "May 04, 2020 10:20 AM PDT",
                        "last_message_received_on": "May 04, 2020 10:20 AM PDT",
                        "status": "OPEN",
                        "last_used_channel": "SMS",
                        "assigned_to": {
                            "id": -100000,
                            "name": "",
                            "type": "T",
                            "emailId": null
                        }
                    }
                ],
                "hasMore": false
            }




+ Response 401

    [1161][]

+ Response 429

    [89][]

+ Response 401

    [1167][]

+ Response 404

    [1011][]


+ Response 400

    [1246][]



# Group Subscription

Subscribe or Unsubscribe multiple webhooks with different URLs or Events for a subscription and deliver real-time notifications.

## Subscribe [/v1/subscriptions/subscribe{?businessId}]
Create webhook subscription listens to subscribed webhook events on a specific passed URL.

### Create subscription [POST]

+ Parameters

    + businessId: 1234567890 (number, required) - Account business number.

+ Request (application/json)

    + Headers

            Accept: application/json
            x-api-key: [Required] Partner specific API key provided by Birdeye for data exchange.

    + Attributes
        + webhookUrl: https://webhook.site/0c27e14d-f833-4589 (string) - The webhook endpoint URL on your server on which webhook requests are to be sent.
        + emails: test@xyz.com, test2@xyz.com (array) - The email id(s) of the business.
        + eventName: APPOINTMENT_BOOKED (string)-  Name of the evnet to be subscribed
                     Events Supported:
                        APPOINTMENT_BOOKED
                        APPOINTMENT_CONFIRMED
                        APPOINTMENT_COMPLETED
                        APPOINTMENT_CANCELLED
                        APPOINTMENT_NOSHOW
                        APPOINTMENT_RESCHEDULED
                        SURVEY_COMPLETED
                        LISTING_UPDATED
                        CONTACT_CREATED
                        CONTACT_UPDATED
                        CONTACT_DELETED
                        CONTACT_ACTIVITY_UPDATE
        + auth (object) - Will be used for basic authorization, should be null for no auth
                + username: username (string)- username for authorization
                + password: password (string)- password for authorization

    + Body

            {
            "webhookUrl": "https://webhook.site/2036c967-0174-4604-8b38-8d5493ed6d65",
            "emails": [
                        "test@xyz.com"
                    ],
            "eventName": "APPOINTMENT_BOOKED",
            "auth": {
                "username": "testUser",
                "password": "userpassword"
            }
            }

+ Response 200 (application/json)

        {
            "id": "abcchdguweUGBSK16789278",
            "message": "You have successfully subscribed to : https://webhook.site/2036c967-0174-4604-8b38-8d5493ed6d65"
        }

+ Response 404

    [1011][]

+ Response 401

    [1161][]

+ Response 429

    [89][]

+ Response 401

    [1167][]


## Unsubscribe [/v1/subscriptions/unsubscribe/{subscriptionId}{?businessId}]
Delete webhook subscription to stop listening to subscribed webhook events on the subscribed url.

### Unsubscribe subscription [GET]

+ Parameters

    + subscriptionId: tyhjwvbtys56782hbjsAGH
    + businessId: 1234567890 (number, required) - Account business number.

+ Request (application/json)

    + Headers

            Accept: application/json
            x-api-key: [Required] Partner specific API key provided by Birdeye for data exchange.

+ Response 200 (application/json)

        {
          "message": "This Subscription has been Unsubscribed"
        }


+ Response 404

    [1011][]

+ Response 401

    [1161][]

+ Response 429

    [89][]

+ Response 401

    [1167][]

+ Response 500 (application/json)

        {
            "code": 1005,
            "message": "Subscription Not found for Particular Id"
        }


# Group Webhook
Configure multiple webhooks with different URLs for a subscription and deliver real-time notifications.

## List webhook events [/v1/messenger/webhook/event]
List webhook events get events via webhook on multiple activities, whether the conversation is open, updated, closed, or a new message has been added.

### Get events [GET]



+ Request (application/json)

    + Headers

            Accept: application/json

+ Response 200 (application/json)

    + Attributes (array)
        + (object)
            + eventId: 1 (number) - Event Id.
            + eventName: conversation.created (string) -  Name of the created event. Possible values are
                conversation.created - A new conversation started,
                conversation.updated - A conversation has been updated with a new status or assigned/unassigned,
                message.added - A new message has been created. Triggered for both sent and received messages,
                and conversation.closed - Conversation is closed..




    + Body

            [
                {
                    "eventId": 1,
                    "eventName": "conversation.created"
                },
                {
                    "eventId": 2,
                    "eventName": "conversation.updated"
                },
                {
                    "eventId": 3,
                    "eventName": "message.added"
                },
                {
                    "eventId": 4,
                    "eventName": "conversation.closed"
                }
            ]



## Create webhook subscription [/v1/messenger/subscribe/webhook/event]
Create webhook subscription listens to webhook events on a specific passed URL.


### Create webhook subscription[POST]


+ Request (application/json)

    + Headers

            Accept: application/json

    + Attributes
        + businessNumber: 169744180007807 (number, required) - The business number for which events to be subscribed. Should always be the account business number not the location business number.
        + apiKey: abcdefgh (string, required) -  Partner specific API key provided by Birdeye for data exchange.
        + events: conversation.created, conversation.updated, message.added, message.closed (array, required) - A list of event name strings from the list of available events that should trigger this webhook. Possible values are
                conversation.created - A new conversation started,
                conversation.updated - A conversation has been updated with a new status or assigned/unassigned,
                message.added - A new message has been created. Triggered for both sent and received messages,
                and conversation.closed - Conversation is closed.
        + endpoint: https://webhook.site/0c27e14d-f833-4589-b201-86b41a651464 (string) - The webhook endpoint URL on your server on which webhook requests are to be sent.

    + Body

            {
                "businessNumber": "755009344",
                "apiKey": "92bcd6e0-c102-43fd-8a67-1a7be5258451",
                "events": [
                    "conversation.created",
                    "conversation.updated",
                    "message.added",
                    "message.closed"
                ],
                "endpoint": "https://webhook.site/0c27e14d-f833-4589-b201-86b41a651464"
            }

+ Response 200 (application/json)

    + Attributes
        + subscriptionId: 1 (number) - Event Id.
        + events: conversation.created, conversation.updated, message.added, message.closed (array, required) - A list of event names that should trigger this webhook.
        + businessId: 755009344 (number) - A unique ID generated by the Birdeye platform that identifies this business.


    + Body

            {
                "subscriptionId": 2,
                "businessId": 755009344,
                "events": [
                    "conversation.created",
                    "conversation.updated",
                    "message.added",
                    "conversation.closed"
                ]
            }

+ Response 401

    [1161][]

+ Response 429

    [89][]

+ Response 401

    [1167][]

+ Response 404

    [1011][]



# Group Competitor
Make competitive insights your unfair advantage.

## Competitor of Enterprise Business [/v1/business/{EnterpriseBusinessNumber}/child{?isCompetitor}]
Competitor of Enterprise Business retrieves list of all competitor businesses for an enterprise.


### Get Competitor Business [GET]


+ Parameters

    + EnterpriseBusinessNumber: 231123123 (string, required) - Enterprise Business id.
    + isCompetitor: true (boolean, required) - True for get competitor business of Enterprise Business and False for get Child Business of Enterprise Business.



+ Request (application/json)

    + Headers

            Accept: application/json
            x-api-key: [Required] Partner specific API key provided by Birdeye for data exchange.


+ Response 200 (application/json)

    + Attributes (array)
        + (object)
            + id: 768996864 (number) - Enterprise Competitor Business Number.
            + name: Environmental Pest Management (string) - Enterprise Competitor Business Name.
            + competitorId: 9876567 (number) - Enterprise Competitor Business ID.
            + alias: Environmental Pest Management - Westerville, OH (string) - Enterprise Competitor Business alias.

    + Body

            [ {
                "id": 768996864,
                "name": "Environmental Pest Management",
                "competitorId" : 2398456,
                "alias": "Environmental Pest Management - Westerville, OH"
            },
            {
                "id": 144670708364016,
                "name": "Sub-reseller",
                "competitorId" : 4598762,
                "alias": "Sub-reseller"
            },
            {
                "id": 144670708364322,
                "name": "Holiday Inn",
                "competitorId" : 9876567,
                "alias": "Holiday Inn"
            }
            ]


+ Response 401

    [1161][]

+ Response 429

    [89][]

+ Response 401

    [1167][]




## Child Business of Competitor [/v1/business/{EnterpriseCompetitorBusinessId}/child{?isCompetitor}]
Get Competitor Child Business retrieves all child locations.


### Get Competitor Child Business [GET]


+ Parameters

    + isCompetitor: true (boolean, required) - True for get competitor business of Enterprise Business and False for get Child Business of Enterprise Business.

+ Request (application/json)

    + Headers

            Accept: application/json
            x-api-key: [Required] Partner specific API key provided by Birdeye for data exchange.


+ Response 200 (application/json)

    + Attributes (array)
        + (object)
            + id: 986031488 (number) - Business ID
            + name: Central Ohio Endodontics (string) - Business Name
            + alias: Central Ohio Endodontics - Dublin, OH (number) - Business alias
            + address (object) - Business address
                + address1: 7405 Morro Rd (string) - Address of the business.
                + address2: Suite 102 (string) - Address of the business.
                + city: Atascadero (string) - City (Max 1000 character long).
                + state: CA (string) - State (2 character state code).
                + countryCode: US (string) - Country Code (2 character country code).
                + zip: 93422 (string) - Zip Code.
                + countryName: United States of America (string) - Country Name (2 character country code).
            + phone: 1234567890 (string) - Business phone.
            + type: Business (string) - Type of account. e.g. Reseller (when it is a sub-reseller), Enterprise-Location (location based enterprise), Enterprise-Product (product based enterprise), Business (SMB/Enterprise location), Product (Enterprise product).
            + status: active (string) - Business status
            + createdOn: Dec 04, 2013 (string) - Business singup date
            + compAccountId: 7876807 (number) - Competitor Location Ids.
            + childCount: 3 (number) - Child account count(applicable only for Reseller, Enterprise-Location, Enterprise-Product).


    + Body

            [{
                "id": 986031488,
                "name": "Central Ohio Endodontics",
                "alias": "Central Ohio Endodontics - Dublin, OH",
                "address": {
                  "address1": "5152 Blazer Memorial Pkwy",
                  "address2": "Ste 102",
                  "city": "Dublin",
                  "state": "OH",
                  "zip": "43017",
                  "countryCode": "US",
                  "countryName": "United States of America"
                },
                "phone": "(614) 896-2801",
                "type": "Business",
                "status": "active",
                "createdOn": "Dec 04, 2013",
                "compAccountId":7876807
            },
            {
                "id": 768996864,
                "name": "Environmental Pest Management",
                "alias": "Environmental Pest Management - Westerville, OH",
                "address": {
                    "address1": "200 Hoff Rd",
                    "address2": "Unit P",
                    "city": "Westerville",
                    "state": "OH",
                    "zip": "43082",
                    "countryCode": "US",
                    "countryName": "United States of America"
                },
                "phone": "(614) 771-8605",
                "type": "Business",
                "status": "active",
                "createdOn": "Dec 05, 2013",
                "compAccountId":4567893
            },
            {
                "id": 144670708364016,
                "name": "Sub-reseller",
                "alias": "Sub-reseller",
                "status": "active",
                "createdOn": "Nov 05, 2013",
                "type": "Reseller",
                "childCount": 1
            },
            {
                "id": 144670708364322,
                "name": "Holiday Inn",
                "alias": "Holiday Inn",
                "status": "active",
                "createdOn": "Nov 01, 2013",
                "type": "Enterprise-Location",
                "childCount": 2
            }
            ]

+ Response 401

    [1161][]

+ Response 429

    [89][]

+ Response 401

    [1167][]


## Get Competitors [/v1/business/{businessId}/competitors]
Get Business Competitors retrieves competitor’s details for an enterprise.

### Get Business Competitors [GET]

+ Parameters

    + businessId: 986031488 (string, required) - Account Business Number.


+ Request (application/json)

    + Headers

            Accept: application/json
            x-api-key: [Required] Partner specific API key provided by Birdeye for data exchange.

+ Response 200 (application/json)

    + Attributes (array)
        + (object)
            + enterpriseId: 986031488 (number) - Enterprise Business Number.
            + enterpriseName: Taj (string) - Enterprise Name.
            + businessCompetitors (array) - List of business competitors
                + (object)
                    + businessId: 986031488 (number) - Competitor Business Number.
                    + name: Texas (string) - Competitor Business Name.
                    + location (object) - Address details
                        + address1: 7405 Morro Rd (string) - Address of the business.
                        + address2: Suite 102 (string) - Address of the business.
                        + city: Atascadero (string) - City (Max 1000 character long).
                        + state: CA (string) - State (2 character state code).
                        + countryCode: US (string) - Country Code (2 character country code).
                        + zip: 93422 (string) - Zip Code.
                        + countryName: United States of America (string) - Country Name (2 character country code).
                        + lat (string) - Latitude.
                        + lng (string) - Longitude.





    + Body

            [
                {
                        "enterpriseId": 144679606934805,
                        "enterpriseName": "taj",
                        "businessCompetitors": [{
                                "businessId": 144681844334495,
                                "name": "texas",
                                "location":{
                                        "address1": "44/5",
                                        "address2": "II-street",
                                        "city": "San Jose",
                                        "state": "CA",
                                        "zip": "102634",
                                        "countryCode": "US",
                                        "countryName": null,
                                        "lat": null,
                                        "lng": null
                                }
                        }]
                },
                {
                        "enterpriseId": 144679577771476,
                        "enterpriseName": "pullman",
                        "businessCompetitors": [{
                                "businessId": 144974367274032,
                                "name": "paris",
                                "location":{
                                        "address1": "b/t 24th St",
                                        "address2": "Mission",
                                        "city": "San Francisco",
                                        "state": "CA",
                                        "zip": "90011",
                                        "countryCode": null,
                                        "countryName": null,
                                        "lat": null,
                                        "lng": null
                                }

                        }]
                }
            ]

+ Response 401

    [1161][]

+ Response 429

    [89][]

+ Response 404

    [1011][]

+ Response 401

    [1167][]


## Create Competitor Enterprise [/v1/signup/competitor/{businessNumber}]
Create New Competitor Enterprise creates a new competitor for an enterprise.


### Create New Competitor Enterprise [POST]

+ Parameters

    + businessNumber: 169744180007807 (string, required) - Account Business Number.


+ Request (application/json)

    + Headers

            Accept: application/json
            x-api-key: [Required] Partner specific API key provided by Birdeye for data exchange.

    + Attributes
        + businessName: Location_compca (string) - Location competitor name.
        + userEmailId: ron@test.com (string) - Location user email.
        + countryCode: CA (string) - Location country code.
        + phone: 408-234-5272 (string) - Location phone number.
        + zip: 95035 (string) - Zip code.
        + competitorId: 100037693 (string) - Competitor Id.
        + type: Product (string) - Business type.


    + Body

            {
                "businessName": "Location_compca",
                "userEmailId": "ron@test.com",
                "countryCode": "CA",
                "phone": "408-234-5272",
                "zip": "95035",
                "competitorId": 100037693,
                "type": "Product"
            }


+ Response 200

    + Attributes
        + competitorId: 100037739 (number) - Enterprise Competitor Business ID.
        + templateid: 0 (number) - Template Id.
        + isAggregationRequired: 1 (number) - Is agrgegation required.
        + type: Enterprise-Location-Competitor (string) - Type.
        + businessNumber: 169744180007807 (number) - Enterprise Competitor Business Number.
        + businessAlreadyPresent: false (boolean) - Is Business Already Present.

    + Body

            {
                "competitorId": 100037739,
                "templateid": 0,
                "isAggregationRequired": 1,
                "type": "Enterprise-Location-Competitor",
                "businessNumber": 161295237142347,
                "businessAlreadyPresent": false
            }

+ Response 401

    [1161][]

+ Response 429

    [89][]

+ Response 404

    [1011][]

+ Response 401

    [1167][]




## Create Child Business [/v1/signup/competitor/{businessId}]
Create New Child Business in Competitor Enterprise creates a new child business for a competitor enterprise.

### Create New Child Business in Competitor Enterprise [POST]

+ Parameters

    + businessId: 986031488 (string, required) - Account Business Number.


+ Request (application/json)

    + Headers

            Accept: application/json
            x-api-key: [Required] Partner specific API key provided by Birdeye for data exchange.

+ Response 200

    + Attributes
        + competitorId: 100037739 (number) - Enterprise Competitor Business ID.
        + templateid: 0 (number) - Template Id.
        + isAggregationRequired: 1 (number) - Is agrgegation required.
        + type: Enterprise-Location-Competitor (string) - Type.
        + businessNumber: 169744180007807 (number) - Enterprise Competitor Business Number.
        + businessAlreadyPresent: false (boolean) - Is Business Already Present.


    + Body

            {
                "competitorId": 100037701,
                "templateid": 0,
                "isAggregationRequired": 0,
                "type": "Product",
                "businessNumber": 161278371646396,
                "compAccountId": 1795,
                "businessAlreadyPresent": true
            }

+ Response 401

    [1161][]

+ Response 429

    [89][]

+ Response 404

    [1011][]

+ Response 401

    [1167][]




## Add Aggregation Link [/v1/aggregation/competitor/{compAccountId}/{businessNumber}]
Add new Competitor Aggregation URL adds an aggregation URL for a competitor location.


### Add new Competitor Aggregation URL [POST]

+ Parameters

    + businessNumber: 169744180007807 (number, required) - Id of the business.
    + compAccountId : 234567 (number, required) - Competitor Account Id.

+ Request (application/json)

    + Headers

            Accept: application/json
            x-api-key: [Required] Partner specific API key provided by Birdeye for data exchange.

    + Attributes
        + sourceAlias: citysearch (string, required) - Source alias.
        + url: http://www.citysearch.com/biz/maria-da-vittorio-san-francisco (string, required) - Source url to be added.


    + Body

            {
                "sourceAlias" : "citysearch ",
                "url" : "http://www.citysearch.com/biz/maria-da-vittorio-san-francisco"
            }


+ Response 200 (application/json)

    + Attributes
        + id: 237030543 (number) - Id of the created Aggregation.
        + sourceAlias: citysearch (string) - Alias of the source.
        + sourceName: Citysearch (string) - Name of the source.
        + sourceUrl: http://www.citysearch.com/biz/maria-da-vittorio-san-francisco (string) - Url of the souce.
        + sourceId: 2 (number) - Id of the source.
        + compAccountId: 1765 (number) - Competitor account id.



     + Body

            {
                "id": 140179308,
                "sourceId": 2,
                "compAccountId": 1765,
                "sourceUrl": "https://www.google.com/maps/place/Rama+Sai+Medical+Store/@28.4390976,76.9596497,11z/data=!4m8!1m2!2m1!1sreviews+google!3m4!1s0x390d04b550d23f2d:0x7e948cb85612d0!8m2!3d28.61074!4d77.0798476",
                "sourceName": "Google",
                "thumbnailUrl": "source/icons/2.png",
                "backGroundColor": "#dd4b39",
                "textColor": "#ffffff",
                "userName": null,
                "password": null,
                "profileId": null,
                "reviewFormUrl": "https://www.google.com/maps/place/Rama+Sai+Medical+Store/@28.4390976,76.9596497,11z/data=!4m8!1m2!2m1!1sreviews+google!3m4!1s0x390d04b550d23f2d:0x7e948cb85612d0!8m2!3d28.61074!4d77.0798476",
                "aggregationStatus": 3,
                "sourceAlias": "google",
                "disabledAggregation": null,
                "disabledAggregationReason": null
            }

+ Response 401

    [1161][]

+ Response 429

    [89][]

+ Response 404

    [1011][]

+ Response 401

    [1167][]

## Get Competitor Review [/v1/review/businessId/{CompetitorEnterpriseBusinessId}{?sindex,count,isCompetitor}]
Get Competitor Review returns the list of review(s) of competitors for an account.

### Get Competitor Reviews [POST]

+ Parameters

    + sindex: 10 (integer, required) - Start index of the reviews.
    + count: 30 (integer, required) - Number of reviews to query.
    + isCompetitor: false (boolean, required) - True for Competitor Review.


+ Request (application/json)

    + Headers

            Accept: application/json
            x-api-key: [Required] Partner specific API key provided by Birdeye for data exchange.

    + Attributes
        + fromDate: 04/01/2013 (string) - Review date (start) in UTC format.
        + toDate: 04/01/2013 (string) - Review date (end) in UTC format.
        + updateFromDate: 04/01/2013 (string) - Review updated date (start) in UTC format.
        + updateToDate: 04/01/2013 (string) - Review updated date (end) in UTC format.
        + sources: google (string) - Aggregation source name Note: use "our_website" to filter reviews posted on Birdeye platform or use "direct_feedback" for direct feedback.
        + ratings: 4,5 (array) - Review rating Possible values 0,1,2,3,4,5.
        + searchStr: Great service (string) - String that is contained by review.
        + subBusinessIds: 123456789 ,987654321 (array) - BusinessIds under enterprise account.
        + statuses: published,parked (array) - Review status. Valid values are "published","parked","all". Default is "published" only.


    + Body

            {
                "fromDate":"04/01/2013",
                "toDate":"05/3/2015",
                "updateFromDate":"04/01/2013",
                "updateToDate":"05/3/2015",
                "sources":["google","citysearch"],
                "ratings":[1,2,3,4,5,0],
                "searchStr":"test string",
                "subBusinessIds":[145308764185002,145308769721320,145308702026610],
                "statuses":["published","parked"]
            }

+ Response 200 (application/json)

    + Attributes (array)
        + (object)
            + reviewId: 1858537291 (number) - Id of the review.
            + rating: 5.0 (number) - Overall rating for the review, in case of direct feedback and facebook recommendations it will be 0. For Facebook recommendations, value will be 1, Non recommended review will have value set as 0.
            + comments: Great service, excellent food (string) - User comment.
            + reviewer - Reviewer details
                + firstName: Ron (string) :
                + lastName: Spector (string) :
                + nickName: Ron Spector (string) :
                + thumbnailUrl: https://ddjkm7n7lx.cloudfront.net/reviewer/dc42f6d8b2b84dc0b688c43e616.jpeg (string) : Thumbn
            + sourceType: Direct Feedback (string) - Source of the review if it is an aggregated review.
            + reviewURL: https://www.facebook.com/Imp-Flow-17565744/reviews (string) - Review url
            + reviewDate: Jan 20, 2014 (string) - Review posted date.
            + response: Thanks you for the review (string) - Review response text.
            + responseDate: Jan 20, 2014 (string) - Response date.
            + enableReply: true (boolean) - Whether a review reply is supported via Birdeye API or not.
            + customerId: 123456 (number) - Customer's Id attributed with this review (if any).
            + extraParams (object) - Key value pair of custom field(s) associated with the customer attributed to the review (if any)

    + Body

            [{
                "reviewId": "3947127516862",
                "rating": 4,
                "comments": "Our water polo team stayed there for 4 nights while in for a tournament. It fit our needs perfectly. The rooms were squeaky clean and comfortable. The housekeeping staff was super efficient and k...",
                "title": null,
                "reviewer": {
                    "firstName": null,
                    "lastName": null,
                    "nickName": "Jen C.",
                    "thumbnailUrl": "http://d3cnqzq0ivprch.cloudfront.net/demo/css/images/default-profile.png",
                    "emailId": null,
                    "facebookId": null,
                    "city": "Ann Arbor",
                    "state": "MI"
                },
                "reviewUrl": "http://www.citysearch.com/not_recommended_reviews/Knzq0i-RsFqWRaNKNWOQbw",
                "sourceType": "citysearch",
                "reviewDate": "Aug 01, 2014",
                "response": null,
                "responseDate": null,
                "featured": 1,
                "businessId": "755009344",
                "uniqueReviewUrl":"https://birdeye.com/websiter-755009344/review/3947127516862",
                "businessName":"Websiter",
                "businessType":"Location"
            },
            {
                "reviewId": "3947077656849",
                "rating": 4,
                "comments": "Was scared when I saw that is was more if a motel the hotel, but for one night we would give it a try. The rooms were clean and the desk help was also good. It was a little noise but I fell aslee...",
                "title": null,
                "reviewer": {
                    "firstName": null,
                    "lastName": null,
                    "nickName": "Stella S.",
                    "thumbnailUrl": "http://d2xt3xymj142xp.cloudfront.net/reviewer/4b7339a2c966485ab58ceaf7ae49e91e.jpeg",
                    "emailId": null,
                    "facebookId": null,
                    "city": "Diamond Bar",
                    "state": "CA"
                },
                "reviewUrl": "http://www.citysearch.com/biz/holiday-inn-express-san-jose-central-city-san-jose?hrid=mJpfRj7QaZzxaaLFRfR48w&nb=1",
                "sourceType": "citysearch",
                "reviewDate": "Jul 31, 2014",
                "response": null,
                "responseDate": null,
                "featured": 0,
                "businessId": "755009344",
                "uniqueReviewUrl":"https://birdeye.com/websiter-755009344/review/3942327516353",
                "businessName":"Websiter",
                "businessType":"Location"
            }
            ]



+ Response 401

    [1161][]

+ Response 429

    [89][]

+ Response 404

    [1011][]

+ Response 400

    [1163][]

+ Response 401

    [1164][]

+ Response 400

    [1167][]

+ Response 4010

    [1186][]

+ Response 400

    [1187][]

+ Response 400

    [1227][]

+ Response 400

    [1228][]




## Competitive Insight Category [/v1/competitors/competitive-insight/categories/{businessNumber}]
Get Score retrieves Insights category details for a competitor.

### Get Score [POST]

+ Parameters

    + businessNumber: 169744180007807 (string, required) - Account Business Number.


+ Request (application/json)

    + Headers

            Accept: application/json
            x-api-key: [Required] Partner specific API key provided by Birdeye for data exchange.

    + Attributes
        + sourceType: review (string) - Type of source e.g. review [by default] or social.
        + sources: google,citysearch (array) - Aggregation sources.
        + timePeriodSelected: all (string) - For all time : all.
        + startDate: 11/02/2020 (string) - Date from which data has to be fetched[MM/DD/YYYY].
        + endDate: 01/06/2021 (string) - Date until which data has to be fetched[MM/DD/YYYY].
        + competitors (array) - List of competitors
            + (object)
                + competitorId: 530846 (number) -  Enterprise Competitor Ids [competitorId in Competitor of Enterprise Business API].
                + compAccountIds: 162426,162427 (array) - Locations Ids of competitor account [compAccountIds in Child Business of Competitor API].

    + Body

            {
                "sourceType": "review",
                "sources": ["google","citysearch"]
                "startDate":"11/02/2020",
                "endDate":"01/06/2021",
                "competitors": [
                    {
                        "competitorId": 530846,
                        "compAccountIds": [162426]
                    },
                    {
                        "competitorId": 535009,
                        "compAccountIds": [234589]
                    }
                ]
            }

+ Response 200

+ Attributes
        + cats (array) - Category details.
            + (object)
                + catId: 16643 (number) - Id of the category.
                + catName: ambience (string) - Name of Category.
                + catStats (array) - Category stats.
                    + (object)
                        + entId: 398331 (string) - Enterprise Id.
                        + entName: Social Stress (string) - Enterprise Name.
                        + competitor: false (boolean) -  true if enterprise is a competitor, else false.
                        + grade: A (string) - Grade according to category.
                        + colorCode: #32661d (string) - Color code.
                        + avgScr: 4.4 (number) -  Average Score.
                        + ct: 3146 (number) - Total count/score.
                + subCats (array) - Sub Category details.
                    + (object)
                        + catId: 16643 (number) - Id of the Sub category.
                        + catName: ambience (string) - Name of Sub Category.
                        + catStats (array) - Sub Category stats.
                            + (object)
                                + entId: 398331 (string) - Enterprise Id.
                                + entName: Social Stress (string) - Enterprise Name.
                                + competitor: false (boolean) -  true if enterprise is a competitor, else false.
                                + grade: A (string) - Grade according to Sub category.
                                + colorCode: #32661d (string) - Color code.
                                + avgScr: 4.4 (number) -  Average Score.
                                + ct: 3146 (number) - Total count/score.



    + Body

            {
              "cats": [
                {
                  "catId": 16643,
                  "catName": "ambience",
                  "catStats": [
                    {
                      "entId": 398331,
                      "entName": "Social Stress",
                      "competitor": false,
                      "grade": "A",
                      "colorCode": "#32661d",
                      "avgScr": 4.4,
                      "ct": 3146
                    }
                  ],
                  "subCats": [
                    {
                      "catId": 16644,
                      "catName": "xyx",
                      "catStats": [
                        {
                          "entId": 398331,
                          "entName": "Social Stress",
                          "competitor": false,
                          "grade": "A",
                          "colorCode": "#32661d",
                          "avgScr": 4.1,
                          "ct": 1173
                        }
                      ]
                    }
                  ]
                },
                {
                  "catId": 15299,
                  "catName": "test1",
                  "catStats": [
                    {
                      "entId": 398331,
                      "entName": "Social Stress",
                      "competitor": false,
                      "grade": "B+",
                      "colorCode": "#a0cfa2",
                      "avgScr": 3.7,
                      "ct": 2249
                    }
                  ]
                }
              ]
            }

+ Response 401

    [1161][]

+ Response 429

    [89][]

+ Response 404

    [1011][]

+ Response 401

    [1167][]



## Competitive Insight Themes [/v1/competitors/competitive-insight/themes/{businessNumber}]
Get Theme Statistics retrieves Insights topic details for a competitor.

### Get Theme Statistics [POST]

+ Parameters

    + businessNumber: 169744180007807 (string, required) - Account Business Number.

+ Request (application/json)

    + Headers

            Accept: application/json
            x-api-key: [Required] Partner specific API key provided by Birdeye for data exchange.

    + Attributes
        + sourceType: review (string) - Type of source e.g. review [by default] or social.
        + sources: google,citysearch (array) - Aggregation sources.
        + timePeriodSelected: all (string) - For all time : all.
        + startDate: 11/02/2020 (string) - Date from which data has to be fetched[MM/DD/YYYY].
        + endDate: 01/06/2021 (string) - Date until which data has to be fetched[MM/DD/YYYY].
        + competitors (array) - List of competitors
            + (object)
                + competitorId: 530846 (number) -  Enterprise Competitor Ids [competitorId in Competitor of Enterprise Business API].
                + compAccountIds: 162426,162427 (array) - Locations Ids of competitor account [compAccountIds in Child Business of Competitor API].
        + topThm: 25 (number) - Count of top Themes to be fetched.
        + orderBy: occurrence (string) - Order of the result e.g.: "occurrence"[default] or "ztoa" or "atoz"
        + sentiment: 0 (number) - -1 = negative sentiment,
                                    1 = positive sentiment,
                                    0 = all sentiments [default].

    + Body

            {
                "sourceType": "review",
                "sources": ["google","citysearch"],
                "startDate":"11/02/2020",
                "endDate":"01/06/2021",
                "competitors": [
                {
                    "competitorId": 530846,
                    "compAccountIds": [ 162426, 144352 ]
                },
                {
                    "competitorId": 720708,
                    "compAccountIds": [ 165432 ]
                }
                ],
                "topThm": 25,
                "orderBy": "occurrence",
                "sentiment": -1
            }

+ Response 200


    + Attributes
        + id: 398331 (number) - Business Id.
        + name: Social Stress (string) - Name of Enterprise.
        + themes: your money (array) - List of Themes.
        + occr: 3 (number) - Occurence.
        + avgScore: 1.0 (number) - Average Score.
        + pPrct: 0.0 (number) - Positive Percentage.
        + nPrct: 0.047169812 (number) - Negative Percentage.
        + prct: 0.0063035805 (number) - Percentage
        + pCt: 30707 (number) - Positive Count.
        + nCt: 6360 (number) - Negative Count.
        + ct: 47592 (number) -  Total Count.
        + themeStats (array) - List of Theme details
            + (object)
                + theme: your money (string) - Theme.
                + adj: your (string) - Adjective
                + kw: money (string) - Keyword.
                + pCt: 0 (number) - Positive Count.
                + nCt: 3 (number) - Negative Count.
                + ct: 3 (number) - Total Count.
                + score: 3 (number) - Score.
                + scr: 1.0 (number) - Scr.
        + competitors (array) - Competitor details.
            + (object)
                + id: 398331 (number) - Business Id.
                + name: Social Stress (string) - Name of Enterprise.
                + themes: your money (array) - List of Themes.
                + occr: 3 (number) - Occurence.
                + avgScore: 1.0 (number) - Average Score.
                + pPrct: 0.0 (number) - Positive Percentage.
                + nPrct: 0.047169812 (number) - Negative Percentage.
                + prct: 0.0063035805 (number) - Percentage
                + pCt: 30707 (number) - Positive Count.
                + nCt: 6360 (number) - Negative Count.
                + ct: 47592 (number) -  Total Count.
                + themeStats (array) - List of Theme details
                    + (object)
                        + theme: your money (string) - Theme.
                        + adj: your (string) - Adjective
                        + kw: money (string) - Keyword.
                        + pCt: 0 (number) - Positive Count.
                        + nCt: 3 (number) - Negative Count.
                        + ct: 3 (number) - Total Count.
                        + score: 3 (number) - Score.
                        + scr: 1.0 (number) - Scr.

    + Body

            {
              "id": 398331,
              "name": "Social Stress",
              "themes": [
                "your money"
              ],
              "occr": 3,
              "avgScore": 1.0,
              "pPrct": 0.0,
              "nPrct": 0.047169812,
              "prct": 0.0063035805,
              "pCt": 30707,
              "nCt": 6360,
              "ct": 47592,
              "themeStats": [
                {
                  "theme": "your money",
                  "adj": "your",
                  "kw": "money",
                  "pCt": 0,
                  "nCt": 3,
                  "ct": 3,
                  "score": 3,
                  "scr": 1.0
                },
                {
                  "theme": "wrong vehicle",
                  "adj": "wrong",
                  "kw": "vehicle",
                  "pCt": 4,
                  "nCt": 4,
                  "ct": 14,
                  "score": 4,
                  "scr": 1.0
                }
              ],
              "competitors": [
                {
                  "id": 530846,
                  "name": "Social 1",
                  "themes": [
                    "your money"
                  ],
                  "occr": 0,
                  "avgScore": 0.0,
                  "pPrct": 0.0,
                  "nPrct": 0.0,
                  "prct": 0.0,
                  "pCt": 41,
                  "nCt": 67,
                  "ct": 132,
                  "themeStats": [
                    {
                      "theme": "young lady",
                      "adj": "young",
                      "kw": "lady",
                      "pCt": 0,
                      "nCt": 1,
                      "ct": 2,
                      "score": 1,
                      "scr": 1.0
                    }
                  ]
                }
              ]
            }

+ Response 401

    [1161][]

+ Response 429

    [89][]

+ Response 404

    [1011][]

+ Response 401

    [1167][]


## Competitive Insight Keywords [/v1/competitors/competitive-insight/keywords/{businessNumber}]
Get Keyword Statistics retrieves Insights keywords details for a competitor.

### Get Keyword Statistics [POST]

+ Parameters

    + businessNumber: 169744180007807 (string, required) - Account Business Number.

+ Request (application/json)

    + Headers

            Accept: application/json
            x-api-key: [Required] Partner specific API key provided by Birdeye for data exchange.

    + Attributes
        + sourceType: review (string) - Type of source e.g. review [by default] or social.
        + sources: google,citysearch (array) - Aggregation sources.
        + timePeriodSelected: all (string) - For all time : all.
        + startDate: 11/02/2020 (string) - Date from which data has to be fetched[MM/DD/YYYY].
        + endDate: 01/06/2021 (string) - Date until which data has to be fetched[MM/DD/YYYY].
        + competitors (array) - List of competitors
            + (object)
                + competitorId: 530846 (number) -  Enterprise Competitor Ids [competitorId in Competitor of Enterprise Business API].
                + compAccountIds: 162426,162427 (array) - Locations Ids of competitor account [compAccountIds in Child Business of Competitor API].
        + topKW: 25 (number) - Count of top Keywords to be fetched.
        + topAd: 25 (number) - Count of top Adjectives to be fetched.
        + orderBy: occurrence (string) - Order of the result e.g.: "occurrence"[default] or "ztoa" or "atoz"
        + sentiment: 0 (number) - -1 = negative sentiment,
                                    1 = positive sentiment,
                                    0 = all sentiments [default].

    + Body

            {
                  "sourceType": "review",
                  "sources": ["google","citysearch"],
                  "startDate":"11/02/2020",
                  "endDate":"01/06/2021",
                  "competitors": [
                    {
                      "competitorId": 530846,
                      "compAccountIds": [
                        162426,
                        144352
                      ]
                    },
                    {
                      "competitorId": 720708,
                      "compAccountIds": [
                        165432
                      ]
                    }
                  ],
                  "topKW": 25,
                  "topAd": 10,
                  "orderBy": "ztoa",
                  "sentiment": -1
                }

+ Response 200

    + Attributes
        + id: 119468 (number) - Business Id
        + name: Social Stress (string) - Name of Enterprise
        + keywords: experience (array) -  List of keywords.
        + ct: 27159 (number) - Count.
        + avgScr: 1.0 (number) - Average Score.
        + keywordStats (array) -
            + (object)
                + keyword: experience (string) - Keyword
                + occurences: 27158 (number) - Occurences
                + score: 1.0 (number) - Score
                + scr: 27158 (number) - Scr.
        + negKWAdjectives (array) - Negative keyword details
            + (object)
                + adjective: horrible (string) - Adjectives
                + occurences: 4137 (number) - Occurences
                + prcnt: 15.232519 (number) - Percentage
                + avgScore: 1.0 (number) - Average Score
        + competitors (array) - Competitor details
            + (object)
                + id: 119468 (number) - Business Id
                + name: Social Stress (string) - Name of Enterprise
                + keywords: experience (array) -  List of keywords.
                + ct: 27159 (number) - Count.
                + avgScr: 1.0 (number) - Average Score.
                + keywordStats (array) -
                    + (object)
                        + keyword: experience (string) - Keyword
                        + occurences: 27158 (number) - Occurences
                        + score: 1.0 (number) - Score
                        + scr: 27158 (number) - Scr.
                + negKWAdjectives (array) - Negative keyword details
                    + (object)
                        + adjective: horrible (string) - Adjectives
                        + occurences: 4137 (number) - Occurences
                        + prcnt: 15.232519 (number) - Percentage
                        + avgScore: 1.0 (number) - Average Score


    + Body

            {
              "id": 119468,
              "name": "Social Stress",
              "keywords": [
                "experience"
              ],
              "ct": 27159,
              "avgScr": 1.0,
              "keywordStats": [
                {
                  "keyword": "experience",
                  "occurences": 27158,
                  "score": 1.0,
                  "scr": 27158
                },
                {
                  "keyword": "lady",
                  "occurences": 2186,
                  "score": 1.0,
                  "scr": 2186
                }
              ],
              "negKWAdjectives": [
                {
                  "adjective": "horrible",
                  "occurences": 4137,
                  "avgScore": 1.0,
                  "prcnt": 15.232519
                }
              ],
              "competitors": [
                {
                  "id": 159180,
                  "name": "Online Competitors",
                  "keywords": [
                    "experience"
                  ],
                  "ct": 1176,
                  "avgScr": 1.0,
                  "keywordStats": [
                    {
                      "keyword": "problem",
                      "occurences": 2972,
                      "score": 1.0,
                      "scr": 2972
                    }
                  ],
                  "negKWAdjectives": [
                    {
                      "adjective": "bad",
                      "occurences": 340,
                      "avgScore": 1.0,
                      "prcnt": 28.911564
                    }
                  ]
                }
              ]
            }

+ Response 401

    [1161][]

+ Response 429

    [89][]

+ Response 404

    [1011][]

+ Response 401

    [1167][]

# Group Competitor AI
Competitive intelligence, simplified by AI.

## Retrieve Competitor Reviews [/v1/competitors/review{?startIndex,pageSize,sortOrder}]
This API retrieves competitor review data for specified business numbers and date ranges.

### Retrieve Competitor Reviews [POST]

+ Parameters
    + startIndex: 0 (number, optional) - The starting index for pagination (0-based). Default is 0.
    + pageSize: 25 (number, optional) - Number of records to return per page (max recommended: 100). Default is 25.
    + sortOrder: 1 (number, optional) - Sort order: 0 = Ascending, 1 = Descending order of review date. Default is 1.

+ Request (application/json)

    + Headers

            Accept: application/json
            x-api-key: [Required] Partner specific API key provided by Birdeye for data exchange.
            x-business-number: [Required] User assosiated businessNumber


    + Attributes


        + businessNumbers: 145308764185002,145308769721320 (array) - Location numbers of enterprise locations. If empty all valid enterprise locations will be selected.
        + fromDate: 04/01/2011 (string) - Start date for the analysis period.
        + toDate: 04/01/2020 (string) - End date for the analysis period.
        + sources: google,citysearch (array) - Aggregation sources.
        + brandIds: 1001,1002 (array) - Filter by specific competitor brand id.
        + competitorLocationIds: 200001,200002 (array) - Filter by specific competitor location IDs.


    + Body

            {
                "businessNumbers": [],
                "fromDate":"04/01/2024",
                "toDate":"08/03/2025",
                "sources":[],
                "brandIds":[],
                "competitorLocationIds":[]
            }


+ Response 200

    + Attributes
            + (object)
                + businessLocations (array) - The list of business locations being analyzed
                    + (object)
                        + businessId: 100031493 (number) - The unique identifier for the business
                        + name: Dieci Lifestyle Spa1 (string) - The name of your business location being analyzed
                        + alias: ST (string, optional) - The alias for the business location
                        + businessNumber: 157984189025195 (number) - Business number for the location
                        + phone:  716-0102 (string, optional) - Phone number of the location
                        + address: 90 W Mount Pleasant Ave (string, optional) - Address of the business location
                + competitorLocation: C1 (string) - The name of the competitor location where the review was left
                + competitorBrand: B1 (string) - The brand name or identifier of the competitor
                + source: Google (string) - The review platform/source where the review was published
                + rating: 4 (number) - The star rating given by the reviewer (1-5 scale)
                + reviewComment: Great experience (string) - The actual text content of the review written by the customer
                + reviewerName: Allen (string) - The name of the person who wrote the review
                + reviewDate: 2024-07-01 (string) - The date when the review was published (YYYY-MM-DD format)
                + reply: Thanks for the review (string) - The business owner's response to the review (if any)

    + Body

        [
            {
                "businessLocations": [
                  {
                    "businessId": 100031493,
                    "name": "Dieci Lifestyle Spa1",
                    "alias": "ST",
                    "businessNumber": 157984189025195,
                    "phone": "(973) 716-0102",
                    "address": "90 W Mount Pleasant Ave"
                  }
                ],
                "competitorLocation": "C1",
                "competitorBrand": "B1",
                "source": "Google",
                "rating": 4,
                "reviewComment": "Great experience",
                "reviewerName": "Allen",
                "reviewDate": "2024-07-01",
                "reply": "Thanks for the review"
            },
            {
                "businessLocations": [
                 {
                    "businessId": 100033957,
                    "name": "Raghav_l",
                    "businessNumber": 159116903548016,
                    "phone": "(202) 555-0175"
                 }
                ],
                "competitorLocation": "Dental Dreams",
                "competitorBrand": "Dental Dreams - 60620",
                "source": "Yelp",
                "rating": 5,
                "reviewComment": "Excellent service!",
                "reviewerName": "Maria",
                "reviewDate": "2024-07-03",
                "reply": "We appreciate your feedback!"
            }
        ]

+ Response 401

    [1161][]

+ Response 429

    [89][]

+ Response 404

    [1011][]

+ Response 401

    [1167][]

## Retrieve Competitor Review Metrics [/v1/competitors/review/metrics{?startIndex,pageSize,sortOrder}]
This API retrieves competitor metrics review data (average rating and total reviews) for specified business numbers and date ranges.

### Retrieve Competitor Review metrics [POST]

+ Parameters
    + startIndex: 0 (number, optional) - The starting index for pagination (0-based). Default is 0.
    + pageSize: 25 (number, optional) - Number of records to return per page (max recommended: 100). Default is 25.
    + sortOrder: 0 (number, optional) - Sort order: 0 = Ascending, 1 = Descending order of review date. Default is 0.

+ Request (application/json)

    + Headers

            Accept: application/json
            x-api-key: [Required] Partner specific API key provided by Birdeye for data exchange.
            x-business-number: [Required] User assosiated businessNumber


    + Attributes


        + businessNumbers: 145308764185002,145308769721320 (array) - Location numbers of enterprise locations. If empty all valid enterprise locations will be selected.
        + fromDate: 04/01/2011 (string) - Start date for the analysis period.
        + toDate: 04/01/2020 (string) - End date for the analysis period.
        + sources: google,citysearch (array) - Aggregation sources.
        + brandIds: 1001,1002 (array) - Filter by specific competitor brand id.
        + competitorLocationIds: 200001,200002 (array) - Filter by specific competitor location IDs.


    + Body

            {
                "businessNumbers": [],
                "fromDate":"04/01/2024",
                "toDate":"08/03/2025",
                "sources":[],
                "brandIds":[],
                "competitorLocationIds":[]
            }


+ Response 200

    + Attributes
                + businessLocations (object) - The list of business locations being analyzed
                    + (object)
                        + businessId: 100031493 (number) - The unique identifier for the business
                        + name: Dieci Lifestyle Spa1 (string) - The name of your business location being analyzed
                        + alias: ST (string, optional) - The alias for the business location
                        + businessNumber: 157984189025195 (number) - Business number for the location
                        + phone:  716-0102 (string, optional) - Phone number of the location
                        + address: 90 W Mount Pleasant Ave (string, optional) - Address of the business location
                + competitorLocation: Aspen Dental - El Paso, TX (string) - The name of the competitor location where the review was left
                + competitorBrand: Aspen Dental - El Paso, TX - 79912 (string) - The brand name or identifier of the competitor
                + source: Google (string) - The review platform/source where the review was published
                + overallRating: 4.7 (number) - The average rating for this competitor location on this specific source
                + reviewCount: 514 (number) - The total number of reviews for this competitor location on this specific source

    + Body

            [
                {
                    "businessLocations": [
                     {
                        "businessId": 100031493,
                        "name": "Dieci Lifestyle Spa1",
                        "alias": "ST",
                        "businessNumber": 157984189025195,
                        "phone": "(973) 716-0102",
                        "address": "90 W Mount Pleasant Ave"
                     }
                    ],
                    "competitorLocation": "Nuvia Dental Implant Center",
                    "competitorBrand": "Nuvia Dental Implant Center",
                    "source": "Google",
                    "overallRating": 4.9,
                    "reviewCount": 1654
                },
                {
                    "businessLocations": [
                     {
                        "businessId": 100031493,
                        "name": "Dieci Lifestyle Spa1",
                        "alias": "ST",
                        "businessNumber": 157984189025195,
                        "phone": "(973) 716-0102",
                        "address": "90 W Mount Pleasant Ave"
                     }
                    ],
                    "competitorLocation": "Aspen Dental - El Paso, TX",
                    "competitorBrand": "Aspen Dental - El Paso, TX - 79912",
                    "source": "Google",
                    "overallRating": 4.7,
                    "reviewCount": 21
                },
                {
                    "businessLocations": [
                     {
                        "businessId": 100033957,
                        "name": "Raghav_l",
                        "businessNumber": 159116903548016,
                        "phone": "(202) 555-0175"
                     }
                    ],
                    "competitorLocation": "Monroe Dental Office",
                    "competitorBrand": "Monroe Dental Office - 10950",
                    "source": "Google",
                    "overallRating": 4.9,
                    "reviewCount": 740
                }
            ]

+ Response 401

    [1161][]

+ Response 429

    [89][]

+ Response 404

    [1011][]

+ Response 401

    [1167][]

# Group Google Q&A

> __Note__
> - _Applicable to be used only by paid listings clients, for their active locations, for the Google Q&A section, in the Google listing_

## Create Question [/v1/qna/question/create{?businessId}]
Create a new question and associated answer

> __Best practise__
> - _Please ensure that a business appropriate question and associated answer is created. Recommendation is to create typical FAQ like questions._


### Create Question [POST]

+ Parameters
    + businessId: 12345678 (string, required) - Id of the business.

+ Request (application/json)

    + Headers

            Accept: application/json
            x-api-key: - Partner specific API key provided by Birdeye for data exchange.

    + Attributes
        + question: Enter question here (string , required ) - text of the question to be posted on Google Q&A profile ; minimum 3 word and 10 characters ; maximum 4096 characters
        + answer: Enter answer here  (string,required) - text of the answer to be posted on Google Q&A profile ; minimum 1 one non-space character ; maximum 4096 characters


    + Body

            {
                  "question": "Enter question here",
                  "answer": "Enter answer here"
            }


+ Response 200 (application/json)


    + Attributes
        + question_id: 2892   (number)  - unique question identifier

    + Body

            {
                  "question_id":2892
            }

+ Response 401

    [1161][]

+ Response 429

    [89][]

+ Response 404

    [1011][]

+ Response 401

    [1167][]

+ Response 401

    [2478][]

+ Response 401

    [2479][]
+ Response 401

    [2481][]
+ Response 401

    [2485][]

+ Response 401

    [2483][]



## Create Answer [/v1/qna/answer/create{?businessId}]
Add an answer to an existing question. Owner can add only one answer per question.
This API would be needed when you wish to answer a third party raised question. In this use case, you would need to do a GET all Q&A API call, identify the unanswered Q’s and then use this Create Answer API to answer the same.




### Create Answer [POST]

+ Parameters
    + businessId: 12345678 (string, required) - Id of the business.


+ Request (application/json)

    + Headers

            Accept: application/json
            x-api-key: - Partner specific API key provided by Birdeye for data exchange.

    + Attributes
        + questionId: 7812   (number , required ) - unique question identifier
        + answer: Enter answer here  (string,required) - text of the question to be posted on Google Q&A profile ; minimum 1 one non-space character ; maximum 4096 characters


    + Body

            {
                  "questionId": 7812,
                  "answer": "Enter answer here"
            }


+ Response 200 (application/json)


    + Attributes
        + answer_id: 2893  (string)  - unique answer identifier

    + Body

            {
                  "answer_id":2893
            }

+ Response 401

    [1161][]

+ Response 429

    [89][]

+ Response 404

    [1011][]

+ Response 401

    [1167][]

+ Response 401

    [2478][]

+ Response 401

    [2479][]

+ Response 401

    [2481][]

+ Response 401

    [2485][]

+ Response 401

    [2483][]
+ Response 401

    [2461][]

+ Response 401

    [2462][]



## Update Question [/v1/qna/question/update{?businessId}]
Update an existing question. You can edit/ update an existing question posted / created by you. Google does not allow you to edit/ update a third party posted Question.



### Update Question [PUT]


+ Parameters
    + businessId: 12345678 (string, required) - Id of the business.


+ Request (application/json)

    + Headers

            Accept: application/json
            x-api-key: - Partner specific API key provided by Birdeye for data exchange.

    + Attributes
        + questionId: 7812  (number , required ) - unique question identifier
        + question: Enter question here  (string,required) - text of the question to be posted on Google Q&A profile ; minimum 3 word and 10 characters ; maximum 4096 characters


    + Body

            {
                  "questionId": 7812,
                  "question": "Enter question here"
            }


+ Response 200 (application/json)

+ Response 401

    [1161][]

+ Response 429

    [89][]

+ Response 404

    [1011][]

+ Response 401

    [1167][]

+ Response 401

    [2478][]

+ Response 401

    [2479][]

+ Response 401

    [2481][]

+ Response 401

    [2485][]

+ Response 401

    [2483][]
+ Response 401

    [2461][]

+ Response 401

    [2480][]
+ Response 401

    [2482][]



## Update Answer [/v1/qna/answer/update{?businessId}]
Update an answer to an existing question. You can edit/ update an existing answer posted / created by you. Google does not allow you to edit/ update a third party posted answer



### Update Answer [PUT]


+ Parameters
    + businessId: 12345678 (string, required) - Id of the business.


+ Request (application/json)

    + Headers

            Accept: application/json
            x-api-key: - Partner specific API key provided by Birdeye for data exchange.

    + Attributes
        + questionId: 7812  (number , required ) - unique question identifier
        + answerId: 7813  (number , required ) - unique answer identifier
        + answer: Enter answer here  (string,required) - text of the answer to be posted on Google Q&A profile ; minimum 1 one non-space character ; maximum 4096 characters


    + Body

            {
                  "questionId": 7812,
                  "answerId": 7813,
                  "question": "Enter answer here"
            }


+ Response 200 (application/json)

+ Response 401

    [1161][]

+ Response 429

    [89][]

+ Response 404

    [1011][]

+ Response 401

    [1167][]

+ Response 401

    [2478][]

+ Response 401

    [2479][]

+ Response 401

    [2481][]

+ Response 401

    [2485][]

+ Response 401

    [2483][]
+ Response 401

    [2461][]

+ Response 401

    [2480][]
+ Response 401

    [2482][]


## Delete Question [/v1/qna/question/delete{?businessId}]
Delete existing questions. Only those questions can be deleted which are created by the owner.

> __Note__
> - _Associated answers with the question will also be deleted._



### Delete Question [POST]

+ Parameters
    + businessId: 12345678 (string, required) - Id of the business.


+ Request (application/json)

    + Headers

            Accept: application/json
            x-api-key: - Partner specific API key provided by Birdeye for data exchange.

    + Attributes
        + questionId: 7812 (number , required ) - unique question identifier


    + Body

            {
                  "questionId": 7812

            }


+ Response 200 (application/json)

+ Response 401

    [1161][]

+ Response 429

    [89][]

+ Response 404

    [1011][]

+ Response 401

    [1167][]

+ Response 401

    [2478][]

+ Response 401

    [2479][]

+ Response 401

    [2481][]

+ Response 401

    [2485][]

+ Response 401

    [2483][]
+ Response 401

    [2461][]

+ Response 401

    [2480][]
+ Response 401

    [2482][]


## Delete Answer [/v1/qna/answer/delete{?businessId}]
Delete answers to existing questions. Only that answer can be deleted which is posted by the owner.


### Delete Answer [POST]

+ Parameters
    + businessId: 12345678 (string, required) - Id of the business.


+ Request (application/json)

    + Headers

            Accept: application/json
            x-api-key: - Partner specific API key provided by Birdeye for data exchange.

    + Attributes
        + questionId: 7812 (number , required ) - unique question identifier
        + answerId: 7813 (number , required ) - unique answer identifier



    + Body

            {
                  "questionId": 7812,
                  "answerId":7813

            }


+ Response 200 (application/json)

+ Response 401

    [1161][]

+ Response 429

    [89][]

+ Response 404

    [1011][]

+ Response 401

    [1167][]

+ Response 401

    [2478][]

+ Response 401

    [2479][]

+ Response 401

    [2481][]

+ Response 401

    [2485][]

+ Response 401

    [2483][]
+ Response 401

    [2461][]

+ Response 401

    [2480][]
+ Response 401

    [2482][]


## Delete All Questions and Answers [/v1/qna/question/deleteAll{?businessId}]
Delete all Q&A on the businessId provided.



### Delete All Questions and Answers  [DELETE]

+ Parameters
    + businessId: 12345678 (string, required) - Id of the business.


+ Request (application/json)

    + Headers

            Accept: application/json
            x-api-key: - Partner specific API key provided by Birdeye for data exchange.

    + Attributes
        + questionId: 7812 (number , required ) - unique question identifier
        + answerId: 7813 (number , required ) - unique answer identifier



    + Body

            {
                  "questionId": 7812,
                  "answerId":7813

            }


+ Response 200 (application/json)

+ Response 401

    [1161][]

+ Response 429

    [89][]

+ Response 404

    [1011][]

+ Response 401

    [1167][]

+ Response 401

    [2478][]

+ Response 401

    [2479][]

+ Response 401

    [2481][]

+ Response 401

    [2485][]

+ Response 401

    [2483][]
+ Response 401

    [2461][]

+ Response 401

    [2480][]
+ Response 401

    [2482][]


## Get All Questions and Answers [/v1/qna/get{?businessId}]
Get all Questions and Answers for a Location

### Get All Questions and Answers [POST]

+ Parameters
    + businessId: 12345678 (string, required) - Id of the business.

+ Request (application/json)

    + Headers

            Accept: application/json
            x-api-key: - Partner specific API key provided by Birdeye for data exchange.

    + Attributes
        + startIndex: 0 (number , required ) - start index
        + pageSize:  25 (number,required) - page size


    + Body

            {
                  "startIndex": 0,
                  "pageSize":25
            }


+ Response 200 (application/json)


    + Attributes

        + totalCount: 100 (number)  - Total number of questions
        + questionsAndAnswers (array) - Questions and answers details
            + (object)
                + questionId: 188556 (number) - Unique question identifier.
                + answeredByOwner: true (boolean) - Identified if question was answered by page owner.
                + askedByOwner: true (boolean) - Identifies if question was asked by page owner.
                + question: This is Dummy question  (string) - text of question
                + updatedBy: John (string) - Name of author of question
                + time: 10:52 PM (string) -  time at which question was created/updated hh:mm AM/PM
                + updatedOn: Apr 10, 2024 (string) - Date at which question was created/updated MMM DD, YYYY
                + userProfileLogoUrl: http://logourl (string) - url link to google profile photo of author
                + userCategory: MERCHANT (string) - category of author MERCHANT, REGULAR_USER, LOCAL_GUIDE
                + locationName: abcdefgh (string) - Birdeye registered business name
                + noOfAnswers: 4 (string) - number of answer available on question
                + answers (object) - Answers details
                    + answerId: 6721 (number) - Unique answer identifier.
                    + answer: This is Dummy answer (string) - Text of answer.
                    + answeredByOwner: true (boolean) - Identifies if this answer was added by owner.
                    + updatedBy: John (string) - Name of author of answer.
                    + updatedOn: Apr 10, 2024 (string) - Date at which answer was created/updated format : MMM DD, YYYY
                    + time: 10:52 PM (string) -  time at which answer was created/updated format: hh:mm AM/PM
                    + userCategory: MERCHANT (string) - category of author MERCHANT, REGULAR_USER, LOCAL_GUIDE
                    + userProfileLogoUrl: http://logourl (string) - url link to google profile photo of author


    + Body

            {
                "totalCount": 1,
                "questionsAndAnswers": [
                    {
                        "questionId": 5107,
                        "answeredByOwner": true,
                        "askedByOwner": true,
                        "question": "This is dummy question",
                        "updatedBy": "John",
                        "time": "10:52 PM",
                        "updatedOn": "Apr 10, 2024",
                        "userProfileLogoUrl": "https://logo.png",
                        "userCategory": "MERCHANT",
                        "locationName": "XYZ",
                        "noOfAnswers": 1,
                        "answers": [
                            {
                                "answerId": 5108,
                                "answer": "This is dummy answer",
                                "updatedBy": "John",
                                "updatedOn": "Apr 10, 2024",
                                "answeredByOwner": true,
                                "userCategory": "MERCHANT",
                                "time": "10:52 PM",
                                "userProfileLogoUrl": "https://logo.png"
                            }
                        ]
                    }
                ]
            }

+ Response 401

    [1161][]

+ Response 429

    [89][]

+ Response 404

    [1011][]

+ Response 401

    [1167][]

+ Response 401

    [2466][]


## Get All Unanswered Q&A [/v1/qna/unanswered/get{?businessId}]
Get all Unanswered Questions and Answers for a Location

### Get All Unanswered Questions and Answers [POST]

+ Parameters
    + businessId: 12345678 (string, required) - Id of the business.

+ Request (application/json)

    + Headers

            Accept: application/json
            x-api-key: - Partner specific API key provided by Birdeye for data exchange.

    + Attributes
        + startIndex: 0 (number , required ) - start index
        + pageSize:  25 (number,required) - page size


    + Body

            {
                  "startIndex": 0,
                  "pageSize":25
            }


+ Response 200 (application/json)


    + Attributes

        + totalCount: 100 (number)  - Total number of questions
        + questionsAndAnswers (array) - Questions and answers details
            + (object)
                + questionId: 188556 (number) - Unique question identifier.
                + answeredByOwner: true (boolean) - Identified if question was answered by page owner.
                + askedByOwner: true (boolean) - Identifies if question was asked by page owner.
                + question: This is Dummy question  (string) - text of question
                + updatedBy: John (string) - Name of author of question
                + time: 10:52 PM (string) -  time at which question was created/updated hh:mm AM/PM
                + updatedOn: Apr 10, 2024 (string) - Date at which question was created/updated MMM DD, YYYY
                + userProfileLogoUrl: http://logourl (string) - url link to google profile photo of author
                + userCategory: MERCHANT (string) - category of author MERCHANT, REGULAR_USER, LOCAL_GUIDE
                + locationName: abcdefgh (string) - Birdeye registered business name
                + noOfAnswers: 4 (string) - number of answer available on question
                + answers (object) - Answers details
                    + answerId: 6721 (number) - Unique answer identifier.
                    + answer: This is Dummy answer (string) - Text of answer.
                    + answeredByOwner: true (boolean) - Identifies if this answer was added by owner.
                    + updatedBy: John (string) - Name of author of answer.
                    + updatedOn: Apr 10, 2024 (string) - Date at which answer was created/updated format : MMM DD, YYYY
                    + time: 10:52 PM (string) -  time at which answer was created/updated format: hh:mm AM/PM
                    + userCategory: MERCHANT (string) - category of author MERCHANT, REGULAR_USER, LOCAL_GUIDE
                    + userProfileLogoUrl: http://logourl (string) - url link to google profile photo of author


    + Body

            {
                "totalCount": 1,
                "questionsAndAnswers": [
                    {
                        "questionId": 5107,
                        "answeredByOwner": false,
                        "askedByOwner": false,
                        "question": "This is dummy question",
                        "updatedBy": "John",
                        "time": "10:52 PM",
                        "updatedOn": "Apr 10, 2024",
                        "userProfileLogoUrl": "https://logo.png",
                        "userCategory": "MERCHANT",
                        "locationName": "XYZ",
                        "noOfAnswers": 1,
                        "answers": [
                            {
                                "answerId": 5108,
                                "answer": "This is dummy answer",
                                "updatedBy": "John",
                                "updatedOn": "Apr 10, 2024",
                                "answeredByOwner": false,
                                "userCategory": "MERCHANT",
                                "time": "10:52 PM",
                                "userProfileLogoUrl": "https://logo.png"
                            }
                        ]
                    }
                ]
            }

+ Response 401

    [1161][]

+ Response 429

    [89][]

+ Response 404

    [1011][]

+ Response 401

    [1167][]

+ Response 401

    [2466][]


# Group Google Services

> __Note__
> - _Applicable to be used only by paid listings clients, for their active locations, for the Google Services section, in the Google listing._
> - _No two services should have the same service name. It is recommended that all services created should  HAVE UNIQUE service names._
> - _You CAN have the same service across two diff categories e.g.: Emergency counselling as a $100 paid service can be a service created & mapped to category A - Mental health and category B - Psychotherapy - both categories being present for the same location._


## Create Service [/v1/google-services/service/create{?businessId}]
Create a new service for the account

> __Best practise__
> - _Please ensure that a business appropriate service is created._


### Create Service [POST /v1/google-services/service/create{?businessId}]

+ Parameters
    + businessId: 169744180007807 (number, required) - Id of the account

+ Request (application/json)

    + Headers

            Accept: application/json
            x-api-key: 2uiHKCTi8hSg35MG75aaot0B2SAokhjk (string, required) - Partner specific API key provided by Birdeye for data exchange.

    + Attributes
        + name: Customer Service (string, required) - Service name (1–140 characters)
        + currencyCode: USD (string, optional) - currency code of the paid service
        + price: 100.50 (number, optional) - price of the paid service
        + description: We provide 24x7 customer service (string, optional) - Max 300 characters
        + group: Hair Care (string , optional) - A logical grouping label for related services ; Used internally to categorize services under a common group name ; if not provided ; the service will remain uncategorized ; Note: This field is not synced to Google ; minimum 3 character ; maximum 64 characters
        + duration: 90 (number , optional) - The expected length of time for the service ; expressed in minutes ; Used internally ; Optional ; if not provided ; no default duration will be set. Note: This field is not synced to Google; minimum 1 ; maximum 9999 minutes

    + Body

            {
                "name": "Customer Service",
                "currencyCode": "USD",
                "price": 100.50,
                "description": "We provide 24x7 customer service",
                "group": "Hair Care",
                "duration": 90
            }

+ Response 200 (application/json)

    + Attributes
        + serviceId: SERV10021056 (string) - Unique service identifier

    + Body

            {
                "serviceId": "SERV10021056"
            }


+ Response 401

    [1161][]

+ Response 429

    [89][]

+ Response 404

    [1011][]

+ Response 401

    [1167][]

+ Response 400

    [2486][]

+ Response 400

    [2487][]

+ Response 400

    [2488][]

+ Response 400

    [2489][]

+ Response 400

    [2490][]

+ Response 400

    [2491][]

+ Response 400

    [2492][]

+ Response 400

    [2493][]



## Get All Services [/v1/google-services/services{?businessId,startIndex,pageSize,sortBy,sortOrder}]
Get all services for an account

### Get All Services [POST]

+ Parameters

    + businessId: 169744180007807 (number, required) - Id of the account
    + startIndex: 0 (number) - start index; default 0
    + pageSize: 25 (number) - page size; default 25
    + sortBy: updated (string) - "updated", "name" or "price"; default : updated
    + sortOrder: desc (string) - "asc" or "desc"; default: desc


+ Request (application/json)

    + Headers

            Accept: application/json
            x-api-key: 2uiHKCTi8hSg35MG75aaot0B2SAokhjk (string, required) - Partner specific API key provided by Birdeye for data exchange.

    + Attributes

        + search: SERV10021056 (string) - search phrase for the service. This could be service Id or name phrase, e.g.  "1002", "Customer".

    + Body

            {
                  "search": "Customer Service"
            }


+ Response 200 (application/json)

    + Attributes

        + services (array) - Google services details
            + (object)
                + serviceId: SERV10021056 (string) - Unique service identifier
                + name: Customer Service (string) - name of the service
                + currencyCode: USD (string) - currency code of the paid service
                + price: 100.50 (number) - price of the paid service
                + description: We provide 24x7 customer service (string) - description of the service
                + group: Hair Care (string) - service group
                + duration: 90 (number) - service duration in minutes

    + Body

            {
                "services": [
                    {
                        "serviceId": "SERV10021056",
                        "name": "Customer Service",
                        "currencyCode": "USD",
                        "price": 100.50,
                        "description": "We provide 24x7 customer service",
                        "group": "Hair Care",
                        "duration": 90
                    }
                ]
            }

+ Response 401

    [1161][]

+ Response 429

    [89][]

+ Response 404

    [1011][]

+ Response 401

    [1167][]

+ Response 400

    [2486][]



## Update Service [/v1/google-services/service/update{?businessId}]
Update an existing service of an account.

> __Note__
> - _Any change in service will be reflected across all the locations mapped to the service._

### Update Service [POST]

+ Parameters

    + businessId: 169744180007807 (number, required) - Id of the account


+ Request (application/json)

    + Headers

            Accept: application/json
            x-api-key: 2uiHKCTi8hSg35MG75aaot0B2SAokhjk (string, required) - Partner specific API key provided by Birdeye for data exchange.

    + Attributes

        + serviceId: SERV10021056  (string , required ) - unique service identifier
        + name: Customer Service(string , required ) - text of the service name posted on Google Services profile; name cannot be altered.
        + currencyCode: USD  (string , optional) - text of the paid service currency code to be posted on Google Services profile; This is a mandatory field in case of paid service ; 'USD', 'GBP', 'CAD', 'AUD', 'NZD', 'EUR', 'MXN', 'INR', 'AED', 'CHF', 'CNY', 'CZK', 'EGP', 'HKD', 'HUF', 'IDR', 'ILS', 'JPY', 'KES', 'KRW', 'LKR', 'MAD', 'MOP', 'MYR', 'PHP', 'PLN', 'RON', 'RUB', 'ZAR', 'SEK', 'SGD', 'THB', 'TRY', 'TWD', 'VND', 'SAR', 'KHR', 'MNT', 'NOK' or 'DKK' value
        + price: 100.50  (number , optional) - amount of the paid service price to be posted on Google Services profile; This is a mandatory field in case of paid service ; minimum amount 0.10 ; maximum amount 2147483647
        + description: We provide 24x7 customer service  (string , optional) - text of the service description to be posted on Google Services profile ; minimum 0 character ; maximum 300 characters
        + group: Hair Care (string , optional) - A logical grouping label for related services ; Used internally to categorize services under a common group name ; if not provided ; the service will remain uncategorized ; Note: This field is not synced to Google ; minimum 3 character ; maximum 64 characters
        + duration: 90 (number , optional) - The expected length of time for the service ; expressed in minutes ; Used internally ; Optional ; if not provided ; no default duration will be set. Note: This field is not synced to Google ; minimum 1 ; maximum 9999 minutes


    + Body

            {
                  "serviceId": "SERV10021056",
                  "name": "Customer Service",
                  "currencyCode": "USD",
                  "price": 100.50,
                  "description": "We provide 24x7 customer service",
                  "group": "Hair Care",
                  "duration": 90
            }


+ Response 200 (application/json)

+ Response 401

    [1161][]

+ Response 429

    [89][]

+ Response 404

    [1011][]

+ Response 401

    [1167][]

+ Response 400

    [2486][]

+ Response 400

    [2487][]

+ Response 400

    [2488][]

+ Response 400

    [2489][]

+ Response 400

    [2490][]

+ Response 400

    [2491][]

+ Response 400

    [2492][]

+ Response 400

    [2493][]

+ Response 400

    [2494][]


## Delete Services [/v1/google-services/service/delete{?businessId}]
Delete existing services of an account

> __Note__
> - _Any change in service will be reflected across all the locations mapped to the service._

### Delete Services [POST]

+ Parameters

    + businessId: 169744180007807 (number, required) - Id of the account

+ Request (application/json)

    + Headers

            Accept: application/json
            x-api-key: 2uiHKCTi8hSg35MG75aaot0B2SAokhjk (string, required) - Partner specific API key provided by Birdeye for data exchange.

    + Attributes

        + serviceIds: [SERV10021056, SERV10021057] (array , required) - List of unique service identifier

    + Body

            {
                "serviceIds": [
                    "SERV10021056",
                    "SERV10021057"
                ]
            }

+ Response 200 (application/json)

+ Response 401

    [1161][]

+ Response 429

    [89][]

+ Response 404

    [1011][]

+ Response 401

    [1167][]

+ Response 400

    [2486][]

+ Response 400

    [2495][]


## Get Location Mapping [/v1/google-services/service/location-mapping{?businessId}]
Get location level service - category mapping

### Get Location Mapping [GET]

+ Parameters

    + businessId: 169744180007807 (number, required) - Id of the business


+ Request (application/json)

    + Headers

            Accept: application/json
            x-api-key: 2uiHKCTi8hSg35MG75aaot0B2SAokhjk (string, required) - Partner specific API key provided by Birdeye for data exchange.


+ Response 200 (application/json)

    + Attributes

        + category_name: Marketing (string) - name of the GMB category
        + services (array) - Google services details
            + (object)
                + serviceId: SERV10021056 (string) - Unique service identifier
                + name: Customer Service (string) - name of the service
                + currencyCode: USD (string) - currency code of the paid service
                + price: 100.50 (number) - price of the paid service
                + description: We provide 24x7 customer service (string) - description of the service
                + group: Hair Care (string) - service group
                + duration: 90 (number) - service duration in minutes

    + Body

            {
                "Marketing" : [
                    {
                        "serviceId": "SERV10021056",
                        "name": "Customer Service",
                        "currencyCode": "USD",
                        "price": 100.50,
                        "description": "We provide 24x7 customer service",
                        "group": "Hair Care",
                        "duration": 90
                    },
                    {
                        "serviceId": "SERV10021057",
                        "name": "Marketing Service",
                        "description": "We provide 24x7 marketing service"
                    }
                ],
                "Advertisement" : [
                    {
                        "serviceId": "SERV10021058",
                        "name": "Advertising Service",
                        "currencyCode": "USD",
                        "price": 100.50,
                        "description": "We provide advertising service across various platforms",
                        "group": "Hair Care",
                        "duration": 90
                    }
                ]
            }

+ Response 401

    [1161][]

+ Response 429

    [89][]

+ Response 404

    [1011][]

+ Response 401

    [1167][]

+ Response 400

    [2486][]


## Update Location Mapping [/v1/google-services/services/location-mapping{?businessId}]
Map services to categories at location level


### Update Location Mapping [POST]

> __Note__
> - _Any change will impact the service mapped to all the locations._

+ Parameters

    + businessId: 169744180007807 (number, required) - Id of the business

+ Request (application/json)

    + Headers

            Accept: application/json
            x-api-key: 2uiHKCTi8hSg35MG75aaot0B2SAokhjk (string, required) - Partner specific API key provided by Birdeye for data exchange.

    + Attributes

        + category_name: Marketing (string , required) - name of the GMB category
        + service_id: [SERV10021056, SERV10021057] (array , required) - List of unique service identifier

    + Body

            {
                "Marketing" : ["SERV10021056", "SERV10021057"]
            }


+ Response 200 (application/json)

+ Response 401

    [1161][]

+ Response 429

    [89][]

+ Response 404

    [1011][]

+ Response 401

    [1167][]

+ Response 400

    [2486][]

+ Response 400

    [2487][]

+ Response 400

    [2496][]

+ Response 400

    [2493][]

+ Response 400

    [2494][]



# Group FAQ

To retrieve all Question and Answer (QnA) entries across locations using FAQ APIs, enabling smart support and knowledge features for businesses.

## Get All QnA [/v1/quero/external/get-all-qna{?sIndex,count,order}]
Customers can fetch a paginated, ordered list of all QnA entries available for a business.

### Get All QnA [POST]

+ Parameters

    + sIndex: 0 (number, optional) - The starting index for the records to fetch. Default is 0 if not specified.
    + count: 25 (number, optional) - The number of QnA records to return.Default is 25 if not specified.
    + order: 1 (number, optional) - The ordering in which records should be returned by last updated date (0 for ascending, 1 for descending).Default is 1 if not specified.


+ Request (application/json)

    + Headers

            Accept: application/json
            x-api-key: [Required] Partner specific API key provided by Birdeye for data exchange..
            x-business-number: [Required] User associated businessNumber


    + Attributes

        + businessNumbers: 175009059995828,169028735563867 (array) - [OPTIONAL] Business numbers of locations under enterprise. If not assigned, all valid QnA assigned in the enterprise will be selected.

    + Body

            {
                "businessNumbers": [
                    175009059995828,
                    169028735563867,
                    166609110899853,
                    164873686901155,
                    164863775654389,
                    164847076003414
                ]
            }


+ Response 200

    + Attributes

        + qnAs (array) - List of QnA objects.
            + (object)
                + question (object) - Details for this QnA's question.
                    + text: What payment options does RetailPrime platform support? (string) - The text of the question.
                    + updatedDate: 2026-01-15T09:00:00.000+0000 (string) - Last update date/time (ISO 8601 or yyyy-MM-dd'T'HH:mm:ss.SSSZ).
                    + answers (array) - Array of answers to this question.
                        + (object)
                            + text: RetailPrime supports credit card, debit card, and PayPal payments. (string) - The text of the answer.
                + allLocations: true (boolean) - Indicates if this QnA applies to all business locations.
                + source: USER (string) - Source of the QnA entry, e.g.  "USER", "AI".
                + sourceType: FILE (string) - Indicates the source type when the QnA is AI-generated, such as "LINK", "FILE", and others.
                + sourceValue: https://retailprime.com/docs/payment-options (string, optional) - Reference value for the source, could be a link, filename, etc.
                + businessNumbers: 123456789123456, 987654321987654 (array[number], optional) - Array of location/business numbers, if specific.

    + Body

            {
                "qnAs": [
                    {
                        "question": {
                            "text": "What payment options does RetailPrime platform support?",
                            "updatedDate": "2026-01-15T09:00:00.000+0000",
                            "answers": [
                                {
                                    "text": "RetailPrime supports credit card, debit card, and PayPal payments."
                                }
                            ]
                        },
                        "allLocations": true,
                        "source": "AI",
                        "sourceType": "FILE",
                        "sourceValue": "sample.txt",
                        "businessNumbers": [123456789123456, 987654321987654]
                    }
                ]
            }

+ Response 400

    [1167][]

+ Response 400

    [5008][]

+ Response 400

    [5043][]

+ Response 401

    [1161][]

+ Response 429

    [89][]

+ Response 404

    [1532][]


# Group Listing
Keep your business information accurate and consistent across 50+ websites.


## Fix Listing [/v1/listing/fix{?b_id}]
Fix Listing publishes information on online listing sources. We post presence information on more than 50 online directories.


### Fix Listing [POST]

+ Parameters

    + b_id: 12345678 (number, required) - Id of the business.


+ Request (application/json)

    + Headers

            Accept: application/json
            x-api-key: [Required] Partner specific API key provided by Birdeye for data exchange.

    + Body

            {
            }


+ Response 200

+ Response 401

    [1161][]

+ Response 429

    [89][]

+ Response 401

    [1167][]

+ Response 404

    [1175][]

## Get Location Status Report [/v1/listing/status/location{?businessNumber}]
A detailed view of the listings status at location level

### Get Location Status Report[GET]

+ Parameters

    + businessNumber: 169744180007807 (number, required) - Id of the business.

+ Request (application/json)

    + Headers

            Accept: application/json
            x-api-key: [Required] Partner specific API key provided by Birdeye for data exchange.


+ Response 200

    + Attributes
        + businessName -  Name of the Business/Location.
        + activationStatus: active/demo/inactive (string) - Activation Status of Business/Location
        + lastUpdated: Mon Jun 10 09:49:30 GMT 2024 (string) - Last Updated Date of a Business/Location.
        + locationStatus: Possible Values “Published”,“Scan State” or “Disabled“ (string) - Return the state of Business/Location.
        + totalSites:   44 (number) - Total no. of Sites.
        + syncedCount:   30 (number) - Total no. of Synced sites count.
        + submittedCount: 13 (number) - Total no. of Submitted sites Count.
        + needUpdatesCount:  0 (number) - Total no. of Sites where Action is required.
        + optedOutCount: 0 (number) - Total no. of Opted out sites count.
        + notConnectedCount: 1 (number) - Total no. of Not connected sites count.
        + syncedPercentage: 68.18% (string) - Total no. of Synced Sites Percentage.
        + submittedPercentage: 29.55% (string) - Total no. of Submitted Sites Percentage.
        + needUpdatesPercentage: 0.00% (string) - Total no. of Need Updates Sites Percentage.
        + optedOutPercentage: 0.00% (string) - Total no. of Opted out sites percentage.
        + notConnectedPercentage: 2.27% (string) - Total no. of Not Connected Sites Percentage.
        + publishListings: Please initiate Publish for this locations listings. (string) - Message to initiate publish locations listings.
        + errors (array) - List of Error messages in case of Not Published state if exists.
        + sites (array) - List of location status.
            + siteName: Google (string) - Name of listing source.
            + status: Action Required (string) -  Status of the location on that source. Possible values are :
                        Synced,
                        Submitted,
                        Action Required,
                        Opted out,
                        Connect
            + url: https://maps.google.com/maps?cid=151047735163 (string) - Location source link.
            + errors (array) - Possible errors would be come when status of directory is 'Action Required'




    + Body

            {
                "businessName": "FLTLT - Tulip Cremation Tampa",
                "activationStatus": "active",
                "lastUpdated": "Mon Jun 10 09:49:30 GMT 2024",
                "locationStatus": "Published",
                "publishListings": "Please initiate Publish for this locations listings.",
                "errors":["The selected address is invalid or not supported.",
                "The business description needs to be longer than 200 characters.",
                "Please activate your demo location."],
                "totalSites": 44,
                  "syncedCount": 30,
                  "submittedCount": 13,
                  "needUpdatesCount": 0,
                  "optedOutCount": 0,
                  "notConnectedCount": 1,
                  "syncedPercentage": "68.18%",
                  "submittedPercentage": "29.55%",
                  "needUpdatesPercentage": "0.00%",
                  "optedOutPercentage": "0.00%",
                  "notConnectedPercentage": "2.27%",
                  "sites": [
                    {
                      "siteId": 2,
                      "siteName": "Google Maps",
                      "status": "Action Required",
                      "errors": [
                        "The geographic coordinates and the address you provided do not match. Make sure that the address line and zip code are correct."
                      ],
                      "url": "https://maps.google.com/maps?cid=17209435735184138870"
                    },
                    {
                      "siteId": 110,
                      "siteName": "Facebook",
                      "status": "Connect"
                    },
                    {
                      "siteId": 226,
                      "siteName": "Bing",
                      "status": "In Progress",
                      "url": "https://www.bing.com/maps?ss=ypid.YN377x6765823"
                    },
                    {
                      "siteId": 100,
                      "siteName": "Birdeye",
                      "status": "Synced",
                      "url": "https://birdeye.com/farm-bureau-insurance-163944578027442"
                    },
                    {
                      "siteId": 381,
                      "siteName": "Apple Maps",
                      "status": "Action Required",
                      "errors": [
                        "Apple Category for the business is not available"
                      ]
                    },
                    {
                      "siteId": 142,
                      "siteName": "Opendi",
                      "status": "Action Required",
                      "errors": [
                        "We’re unable to update your listing as there is a 'Claim Listing' issue which requires release of management of listings from the previous listings management provider. Please contact support for assistance."
                      ],
                      "url": "https://columbia-la.opendi.us/10046961.html"
                    }
                  ]
            }



+ Response 401

    [1161][]

+ Response 429

    [89][]

+ Response 401

    [1167][]

+ Response 404

    [1175][]

+ Response 400

    [3333][]


## Listings Insights [/v1/listing/insights{?businessId}]
Insights/Analytics for Google Listings of a given business.

### Listings Insights [POST]

+ Parameters

    + businessId: 12345678 (number, required) - Id of the account.

+ Request (application/json)

    + Headers

            Accept: application/json
            x-api-key: [Required] Partner specific API key provided by Birdeye for data exchange.


    + Attributes

        + businessNumbers: 23456788,1231313 (array) - Location numbers of enterprise locations. If empty all valid enterprise locations will be selected.
        + startDate (string) - Start Date, Format: yyyy-MM-dd.
        + endDate (string) - End Date, Format: yyyy-MM-dd. If startDate and endDate are not provided, then the last 3 months date range will be chosen.
        + viewMode (array,required) - for mobile or desktop or both (if none is provided then data for both will be displayed) Example “Desktop”, ”Mobile”


    + Body

            {
                "businessNumbers": [156387109031976],
                "startDate": "2010-02-01",
                "endDate": "2022-02-01",
                "viewMode": [ "Mobile", "Desktop"]
            }



+ Response 200

    + Attributes

        + mapViewTotalCount: 2868 (number) - Business impressions on Google Maps on Desktop and mobile devices. Multiple impressions by a unique user within a single day are counted as a single impression on Google.
        + searchViewTotalCount: 2868 (number) - Business impressions on Google Search on Desktop and mobile devices. Multiple impressions by a unique user within a single day are counted as a single impression on Google.
        + websiteVisitsTotalCount: 2868 (number) - The number of times the business profile website was clicked on Google.
        + getDirectionsTotalCount: 0 (number) - The number of times a direction request was requested to the business location on Google.
        + callsTotalCount: 2868 (number) - The number of times the business profile call button was clicked on Google.
        + usersReachedTotalCount: 0 (number) - The number of times your business appeared in search results and other services on Facebook.
        + usersEngagedTotalCount: 0 (number) - The number of times users have engaged with your business through reactions, comments, shares and more on Facebook.
        + impressionCountTotalCount: 0 (number) - The number of users who saw the activity from your page including posts, check-ins, and ads on Bing.
        + bingWebsiteVisitsTotalCount: 2868 (number) - The number of times the business profile website was clicked on Bing.
        + bingDirectionsTotalCount: 0 (number) - The number of times a direction request was requested to the business location on Bing.
        + bingCallsTotalCount: 2868 (number) - The number of times the business profile call button was clicked on Bing.
        + liveCount: 10 (number) - Total no of synched sites for a business.
        + entityCount: 1 (number) - Total businesses count.

    + Body

            {
                "mapViewTotalCount": 2868,
                "searchViewTotalCount": 2868,
                "websiteVisitsTotalCount": 2868,
                "getDirectionsTotalCount": 0,
                "callsTotalCount": 2868,
                "usersReachedTotalCount": 0,
                "usersEngagedTotalCount": 0,
                "impressionCountTotalCount": 0,
                "bingWebsiteVisitsTotalCount": 2868,
                "bingDirectionsTotalCount": 0,
                "bingCallsTotalCount": 2868,
                "liveCount": 10,
                "entityCount": 1
            }


+ Response 401

    [1161][]

+ Response 429

    [89][]

+ Response 401

    [1167][]

+ Response 404

    [1175][]



## Listings Insights Datapoints [/v1/listing/report/{reportType}/datapoints{?businessId}]
Datapoints of report graph is date/label mapped to value/data of a given business.

### Listings Insights Datapoints [POST]

+ Parameters

    + reportType: google_view_search_map (string, required) - Report type, Possible values [google_view_search_map, gmb_customer_actions_map, fb_users_reached,fb_users_engaged, bing_impression_count,bing_customer_actions]
    + businessId: 12345678 (number, required) - Id of the account.


+ Request (application/json)

    + Headers

            Accept: application/json
            x-api-key: [Required] Partner specific API key provided by Birdeye for data exchange.

    + Attributes
        + businessNumbers: 23456788,1231313 (array) - Location numbers of enterprise locations. If empty all valid enterprise locations will be selected.
        + startDate (string) - Start Date, Format: yyyy-MM-dd.
        + endDate (string) - End Date, Format: yyyy-MM-dd. If startDate and endDate are not provided, then the last 3 months date range will be chosen with groupByType as the day.
        + viewMode (array) - is data required for mobile or desktop or both (if none is provided then data for both will be displayed)
        + groupByType: year (string) - Group the data accordingly. The default value will be the week. Possible values are
                                                        day,
                                                        week,
                                                        month,
                                                        quarter,
                                                        year


    + Body

            {
                "businessNumbers": [156387109031976],
                "startDate": "2010-02-01",
                "endDate": "2022-02-01",
                "groupByType": "year",
                "viewMode": [ "Mobile", "Desktop"]
            }



+ Response 200

    + Attributes (array)
        + (object)
            + label: 02/01/2020 (string) - The business counts data on a particular date.
            + wsiteVisitsCount: 670 (number) - The number of times the business profile website was clicked.
            + directionsCount: 670 (number) - The number of times a direction request was requested to the business location.
            + callsCount: 670 (number) - The number of times the business profile call button was clicked.

    + Body

            [{
                "label": "02/01/2020",
                "wsiteVisitsCount": 670,
                "directionsCount": 670,
                "callsCount": 670
            },
            {
                "label": "01/01/2021",
                "wsiteVisitsCount": 730,
                "directionsCount": 730,
                "callsCount": 730
            },
            {
                "label": "01/01/2022",
                "wsiteVisitsCount": 730,
                "directionsCount": 730,
                "callsCount": 730
            }
            ]


+ Response 401

    [1161][]

+ Response 429

    [89][]

+ Response 401

    [1167][]

+ Response 404

    [1175][]



## Get GMB Attributes [/v1/listing/{businessNumber}/gmb-attributes-list{?categoryId,countryCode}]
The Get GMB Attributes API fetches the list of applicable GMB attributes for the selected GMB category ID


### Get GMB Attributes [GET]

+ Parameters

    + businessNumber: 169744180007807 (number, required) - Business Number.
    + categoryId: gcid:electrical_installation_service (string, required) - Category id.
    + countryCode: US (string, required) - Code of the country, Possible values are US,CA,AU,PR,NZ,MX,IN,UK,FR,IT.

+ Request (application/json)


    + Headers

            Accept: application/json
            x-api-key: [Required] Partner specific API key provided by Birdeye for data exchange.


+ Response 200

    + Attributes
        + Accessibility (array) - This is dynamic field. Depends upon request inputs.
            + (object)
                + attributeId: has_wheelchair_accessible_restroom (string) - Attribute Id.
                + valueType: BOOL (string) - Attribute value type.
                + displayName: Wheelchair accessible restroom (string) - Attribute display name.
                + groupDisplayName: Accessibility (string) - Attribute group name.
                + valueMetadata (array) - Contains the list of possible values for the attribute.
                    + (object)
                        + value: true - Possible attribute value.
                        + displayName: Wheelchair accessible restroom (string) - Attribute display name.

    + Body

            {
                "Accessibility": [{
                        "attributeId": "has_wheelchair_accessible_restroom",
                        "valueType": "BOOL",
                        "displayName": "Wheelchair accessible restroom",
                        "groupDisplayName": "Accessibility",
                        "valueMetadata": [{
                                "value": "true",
                                "displayName": "Wheelchair accessible restroom"
                            },
                            {
                                "value": "false",
                                "displayName": "No wheelchair accessible restroom"
                            }
                        ]
                    },
                    {
                        "attributeId": "has_wheelchair_accessible_seating",
                        "valueType": "BOOL",
                        "displayName": "Wheelchair accessible seating",
                        "groupDisplayName": "Accessibility",
                        "valueMetadata": [{
                                "value": "true",
                                "displayName": "Wheelchair accessible seating"
                            },
                            {
                                "value": "false",
                                "displayName": "No wheelchair accessible seating"
                        }]
                    }
                ],
                    "Crowd": [{
                        "attributeId": "welcomes_lgbtq",
                        "valueType": "BOOL",
                        "displayName": "LGBTQ+ friendly",
                        "groupDisplayName": "Crowd",
                        "valueMetadata": [{
                            "value": "true",
                            "displayName": "LGBTQ+ friendly"
                        }]
                    },
                    {
                        "attributeId": "is_transgender_safespace",
                        "valueType": "BOOL",
                        "displayName": "Transgender safespace",
                        "groupDisplayName": "Crowd",
                        "valueMetadata": [{
                            "value": "true",
                            "displayName": "Transgender safespace"
                        }]
                    }
                ],
                "Planning": [{
                    "attributeId": "requires_appointments",
                    "valueType": "BOOL",
                    "displayName": "Appointment required",
                    "groupDisplayName": "Planning",
                    "valueMetadata": [{
                        "value": "true",
                        "displayName": "Appointment required"
                    }]
                }]
            }



+ Response 401

    [1161][]

+ Response 429

    [89][]


+ Response 400

    [4011][]

+ Response 400

    [4012][]

+ Response 400

    [4013][]

+ Response 400

    [2521][]

+ Response 400

    [2522][]

## Get Apple Attributes [/v1/listing/{businessNumber}/apple-location-attributes-list]
The Get Apple Attributes API fetches the list of applicable Apple attributes. An attribute is typically something that helps describe your location better. E.g.: You provide paid parking or that your location is kid friendly etc.


### Get Apple Attributes [GET]

+ Parameters

    + businessNumber: 169744180007807 (number, required) - Business Number.

+ Request (application/json)


    + Headers

            Accept: application/json
            x-api-key: [Required] Partner specific API key provided by Birdeye for data exchange.


+ Response 200

    + Attributes
        + Accessibility (array) - This is dynamic field. Depends upon request inputs.
            + (object)

    + Body

            {
                "crossbusiness.family_kids": [{
                        "attributeId": "kidsclub",
                        "description": "Kids club is the facility that a business or establishment has where various social and recreational activities are available for children's entertainment."
                    }
                ],
                    "crossbusiness.goodfor": [{
                        "attributeId": "groups",
                        "description": "Good for groups refer that the establishment is good for people in groups."
                    },
                    {
                        "attributeId": "singles",
                        "description": "Good for singles refer that the establishment is good for people who are single."
                    }
                ],
                    "crossbusiness.barservice": [{
                        "attributeId": "no_alcohol",
                        "description": "Business that does not serve alcohol."
                    },
                    {
                        "attributeId": "bar_lounge",
                        "description": "The bar lounge is the facility where non-alcoholic, alcoholic drinks and other condiments are available in a room with comfortable tables and sittings."
                    }
                ],
                  "crossbusiness.cellphone_rental": []


            }



+ Response 401

    [1161][]

+ Response 429

    [89][]


+ Response 400

    [4011][]

+ Response 400

    [4012][]

+ Response 400

    [4013][]


## Get Apple Action Links [/v1/listing/{businessNumber}/apple-action-links]
The Get Apple Action Links fetches the list of applicable Apple Action Link Types. Apple action links are the click throughs that are displayed in the action row on your Apple Maps listings also known as the Apple Maps Placecard.


### Get Apple Action Links [GET]


+ Parameters

    + businessNumber: 169744180007807 (number, required) - Business Number.

+ Request (application/json)


    + Headers

            Accept: application/json
            x-api-key: [Required] Partner specific API key provided by Birdeye for data exchange.


+ Response 200

    + Attributes
        + Accessibility (array) - This is dynamic field. Depends upon request inputs.
            + (object)

    + Body


             [
                {
                     "id": "quicklinks.parking_available_parking",
                     "name": "Parking"
                },{
                    "id": "quicklinks.parking_reserve_parking",
                    "name": "Reserve"
                },{
                     "id": "quicklinks.restaurant_join_waitlist",
                     "name": "Waitlist"
                },{
                    "id": "quicklinks.restaurant_order_delivery",
                     "name": "Delivery"
                },{
                     "id": "quicklinks.restaurant_order_food",
                     "name": "Order"
                },{
                    "id": "quicklinks.restaurant_pickup",
                     "name": "Pickup"
                }


            ]



+ Response 401

    [1161][]

+ Response 429

    [89][]


+ Response 400

    [4011][]

+ Response 400

    [4012][]

+ Response 400

    [4013][]

## Get Category List [/v1/listing/{businessNumber}/category-list{?sourceName,countryCode}]
The Get Category List API fetches the list of category values for the selected source.

### Get Category List [GET]

+ Parameters

    + businessNumber: 169744180007807 (number, required) - Business Number.
    + sourceName: BING (string, required) -  Source name for which category data needs to be fetched. Possible values are BING, HEALTHCARE, GMB, VENDOR, FACEBOOK, APPLE.
    + countryCode: US (string, required) - Code of the country, Possible values are US,CA,AU,PR,NZ,MX,IN,UK,FR,IT.

+ Request (application/json)


    + Headers

            Accept: application/json
            x-api-key: [Required] Partner specific API key provided by Birdeye for data exchange.


+ Response 200

   + Attributes (array)
        + (object)
            + id: 2 (string) - Category Id.
            + name: Towing Service (string) - Category Name.
            + primary: true (boolean) - It will be present in response only in case when sourceName = “VENDOR”



    + Body

            [
                {
                    "id": "2",
                    "name": "Towing Service",
                    "primary": true
                },
                {
                    "id": "3",
                    "name": "Auto Glass Shop",
                    "primary": true
                },
                {
                    "id": "4",
                    "name": "Car Dealer",
                    "primary": true
                },
                {
                    "id": "6",
                    "name": "Used Car Dealer",
                    "primary": true
                }
            ]




+ Response 401

    [1161][]

+ Response 429

    [89][]


+ Response 400

    [4014][]

+ Response 400

    [4012][]

+ Response 400

    [4013][]

+ Response 400

    [4015][]


## Create Listing [/v1/listing/{businessNumber}/create]
Create Listing API publishes information on online listing sources. We post presence information on more than 50+ online directories. You can use this API to not just create your detailed listing but also fix/ publish/ sync/ make live at the same time.


### Create Listing [POST]

+ Parameters

    + businessNumber: 169744180007807 (number, required) - Business Number.

+ Request (application/json)


    + Headers

            Accept: application/json
            x-api-key: [Required] Partner specific API key provided by Birdeye for data exchange.


   + Attributes
        + businessInfo - Business Information
            + name: Drs. Chalker and Peterson, A Dental Partnership (required, string) - Name of the Business/Product (Max 250 character long).
            + phone (required, string) - Your official Business Phone number. Format is (xxx) xxx-xxxx.
            + websiteUrl: http://www.diecispa.org/ (string) - Business website url.
            + emailId: 4568@livelovespa.com (string) - Business Email ID.
            + isAddressHidden: note that this isn’t supported by all sites Possible Values  “Yes” or “No” (string) - If your business doesn’t have a place for your customers to visit, then you can hide your street address.
            + isServiceAreaProvider: Possible Values “Yes” or “No (string) - If you deliver or provide service at customer locations.
            + mainBusinessDescription: The business is a dental partnership providing general and specialized dental care services, including preventive checkups (string) - A description of the business between 200–750 characters, excluding any URLs, phone numbers, addresses, or promotional content, accurately depicting the nature of the business.
            + serviceAreas (array) - Locations where you deliver or provide service (applicable if isServiceAreaProvider is 'Yes').NOTE: Maximum service areas that can be provided are 10.
                + (object)
                    + description (string) - Area, City, State, Zip, Country. e.g.  "1735 Berryessa Rd, San Jose, CA 95133, USA", “Onalaska, WI, USA”.
            + location (object) - Business address
                + address1: 7405 Morro Rd (string) - Address of the business/location.
                + address2: Suite 102 (string) - Address of the business/location.
                + city: Atascadero (string) - City (Max 1000 character long).
                + state: CA (string) - State (2 character state code).
                + countryCode: US (string) - Country Code (2 character country code).
                + zip: 93422 (required,string) - Zip Code.
        + additionalInfo - Business Additional Information
            + establishedYear: 2012 (number) - Year established
            + timezone: America/Los_Angeles (string)- Timezone of the business.
            + languages: English, Spanish (array) - Languages.
            + moreHours (array) -  Google more hours for specific services you offer such as delivery, takeout, drive-through, and pickup (see: Supported More Hours). Google more hours can only be added if google primary category is added. To get specific types of more hours, please refer to Get supported more hours type api.  NOTE: In more hours, day 0 denotes Monday, day 1 denotes Tuesday, …, day 6 denotes Sunday.
            Please refer /listing/get-more-hours-type/get-more-hours-type api to get google more hours type. Possible Values Breakfast, Lunch, Pickup, etc.
            + appleMoreHours (array) -  Apple more hours for specific services you offer such as Dining, Bar and Delivery. Apple more hours can only be added if apple primary category is added. To get specific types of apple more hours, please refer to Get supported more hours type api.  NOTE: In apple more hours, day 0 denotes Monday, day 1 denotes Tuesday, …, day 6 denotes Sunday.
            Please refer /listing/get-more-hours-type/get-more-hours-type api to get apple more hours type. Possible Values Service Hours, Delivery Service Hours, Dine In Hours etc.
            + wholeWeekOperating: 0 (number) - Whether your business is open 24/7, Possible Values - 0 or 1.
            + hoursOfOperations (array, required) - Regular hours: Regular working hours of the business for each day from Monday to Sunday.
                + (object)
                    + day: 5 (number) - 0(Monday), 1(Tuesday), 2(Wednesday) and so on.
                    + workingHours (array) - Working hours of the business
                        + (object)
                            + startHour: 7:00 (string) - Start hour 9:00 (9 AM), 18:00 (6 PM)
                            + endHour: 17:30 (string) - End hour  9:00 (9 AM), 18:00 (6 PM)
                    + isOpen: 1 (number) - 0 (Business closed today), 1 (open)
                    + comment: By appointment only (string) - Add the special instruction.
            + specialHours (array) - For special holiday days, where you may have limited hours of operation and don’t want to change your preset regular hours. These would only be applicable only for the dates they are set for.
                + (object)
                    + specialDate: 10/20/2023 (string) - It should be "MM/DD/YYYY".
                    + startHour: 7:00 (string) - Start hour 9:00 (9 AM), 18:00 (6 PM)
                    + endHour: 17:30 (string) - End hour  9:00 (9 AM), 18:00 (6 PM)
                    + isOpen: 1 (number) - 0(Business closed today), 1 (open)
            + businessStatus : Open (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 : 10/20/2022 - 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.
            + services:  Other Dental Specialties, Orthodontists, Dentistry (required,string) - Services offered by the business. Useful in SEO. (Comma separated list of services offered) Business services cannot be more than 1000 characters.
            + keywords: Dentists Atascadero CA, Other Dental Specialties Atascadero CA, Orthodontists Atascadero CA (string)- Important keywords related to the business. Useful in SEO. (Comma separated list of important keywords) Business keywords cannot be more than 1000 characters.
            + products: Invisalign, Cookies Set of 8, Brochure design & prints (string) - Products about the business. Useful in SEO and Business products cannot be more than 1000 characters.
            + appointmentLink (string) - Let customers book appointments by redirecting them to your appointments page.
            + reservationLink (string) - Let customers reserve tables by linking them to your reservations page.
            + menuLink (string) - Show customers what you serve by linking them to your menu.
            + orderAheadLink (string) - 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.
            + paymentTypes (array)
                List of payment types accepted by the business.
                + (Members)
                    + China Union Pay
                    + Bitcoin
                    + Cash Accepted
                    + MasterCard
                    + PayPal
                    + Check / Cheque
                    + Contactless Payment
                    + Debit Card
                    + Diners Club
                    + JCB
                    + Financing
                    + Visa
                    + American Express
                    + Cash Only
                    + Rupay
                    + Credit Card
                    + Discover
            + additionalPaymentTypes: Paypal, Visa, Master Card (string) - Additional Payment Type (Max 250 character long).
            + localPhoneNumber (string)- Local phone number.
            + tollFreePhoneNumber (string) - Tollfree number.
            + androidAppURL: http://www.gmail.com (string)- Android app url.
            + iosAppURL: http://www.gmail.com (string) - IOS app url.
        + media (object) - Media details.
            + logoUrl: http://d2xt3xymj142xp.cloudfront.net/712586432/other/ab60b93831ba490383b9c59c0b4cf49d.jpeg (string) - This logo will pushed to your listings sites such as Google, Facebook, Bing, Birdeye and all the other secondary listings sites. Format: JPG, JPEG, PNG. Minimum 250 x 250px. Recommended: 720 X 720 px. 10 KB min.
            + coverImageUrl: http://d2xt3xymj142xp.cloudfront.net/712586432/other/ab60b93831ba490383b9c59c0b4cf49d.jpeg (string) - This cover photo will pushed to your listings sites such as Birdeye and all the other secondary listings sites. Cover image URL for business will be displayed on custom review site.  Format: JPG, JPEG, PNG. Minimum 1110 x 374px. 10 KB min.
            + gmbCover: http://d3cnqzq0ivprch.cloudfront.net/common/css/images/profile/abcd.jpg (string) - Google Cover Image Url.
            + facebookCover: http://d3cnqzq0ivprch.cloudfront.net/common/css/images/profile/fb.jpg (string) - Facebook Cover Image Url.
        + optOut (object) - Opt out section
            + gmbLogoOptOut: true (boolean)- Update profile photo on your google my business page.
                                                    Select ‘true’ if you want to opt out from updating the logo on your GBP page.
                                                    Select ‘false’ if you want to opt in to updating the logo on your GBP page.
            + fbLogoOptOut: false (boolean) - Update profile photo on your facebook profile.
                                                    Select ‘true’ if you want to opt out from updating the logo on your FB business page.
                                                    Select ‘false’ if you want to opt in to updating the logo on your FB business page.
            + gmbCoverOptOut: true (boolean) - Update cover photo on your google my business page.
                                                    Select ‘true’ if you want to opt out from updating the cover photo on your GBP page.
                                                    Select ‘false’ if you want to opt in to updating the cover photo on your GBP page.
            + fbCoverOptOut: true (boolean) - Update cover photo on your facebook profile.
                                                    Select ‘true’ if you want to opt out from updating the cover photo on your FB business page.
                                                    Select ‘false’ if you want to opt in to updating the cover photo on your FB business page.
            + gmbProfileOptOut: false (boolean) - Opt out from the google specific section on the profile page.
                                                        Select ‘true’ if you want to opt out from updating information such as category and related attributes and more hours on your Google Business Profile page.
                                                        Select ‘false’ if you want to opt in to updating information such as category and related attributes and more hours on your Google Business Profile page.
            + businessProfileOptOut: true (boolean) - Opt out from the business profile section.
                                                            Select ‘true’ if you want to opt out from updating NAP information on your Google Business Profile page.
                                                            Select ‘false’ if you want to opt in to updating NAP information on your Google Business Profile page.
        + covidInfo (object) - Provide this data for updating any COVID specific information you want to share with your customers.
            + postDescription (string) - This information is posted and updated on your Google business profile page and your FB business page.
            + covid19SupportLink (string) - Should be a valid covid19 support url
            + virtualCareLink (string) - Should be a valid url virtual care link
        + bingListing (object) - This data will be used to update your Bing listing.
            + primaryCategoryBing (string) - Primary category of bing.
            + bingCategories (array) - You can add a maximum of up to 3 categories.
            + bingPhoneNumber (string) - You can provide a phone number which will be pushed only to your Bing listing site and will override the primary phone number set.
            + bingDescription (string) - An ‘About the business description’. Bing description cannot be more than 4096 characters.
        + internalListing (object) - Provide data for microsite listing purpose.
            + description (required, string) - An ‘about your business’ description. Business description cannot be more than 5000 characters and cannot be less than 200 characters.
            + subCategories (array) - Primary category of business.
            + subcategory (string) - You can add up to 3 subcategories.
            + displayCategory (string) - Choose one of the category either from primary category or from sub categories.
        + facebookListing (object) - This data will be used to update your Facebook business page/ listing.
            + facebookPhoneNumber (string) - Phone number for facebook profile. This phone number will override the main phone number on your Facebook business page
            + categories (array) - You can add up to 3 categories.
            + facebookDescription (string) - An ‘about your business’ description. Facebook description cannot be more than 255 characters.
        + gmbListing (object) - This data will be used to update your Google Business Profile/ listing.
            + googleWebsiteUrl (string) - Website url will update on google listing. This website URL will override your existing website URL on your Google business profile.
            + googlePhoneNumber (string) - You can provide a phone number which will be pushed only to your google listing site and will override the primary phone number set.
            + googleStoreId (string) - Store id for google.
            + primaryCategoryGmb (string) - Primary category of google.
            + additionalCategories (array) - You can add up to 9 subcategories.
            + googleDescription (string) - An ‘about your business’ description. Google description cannot be more than 750 characters.
            + attributes (object) - Google my business attributes are highly visible statements about your business that appear on your Google My Business listing. Supported attributes are
                    Accessibility,Amenities,Crowd,Dining options,Highlights,Planning,Offerings,Health & safety.
            + foodDelivery (string) - Enter the redirect URL where customers can place delivery orders.This field is applicable for hospitality business and is category dependent.Example http://www.ubereats.com
            + foodTakeout (string) - Enter the redirect URL where customers can place 'takeout' food orders. This field is applicable for hospitality business and is category dependent.Example : http://www.ubereats.com
            + whatsappBusinessLink (string) - Enter your WhatsApp Business link to display a direct chat option on your live Google Business Profile. This allows customers to easily message you. Example https://wa.me/<yourphonenumber>
            + textMessageNumber (string) - Enter a valid phone number to enable a text message chat option on your live Google Business Profile, allowing customers to easily reach you via SMS.
        + appleListing (object) - This data will be used to update your Google Business Profile/ listing.
            + phoneNumber (string) - This will be shown as the primary phoneNumber on your Apple maps place card and will replace/ override your business info phone number.
            + appleWebsiteUrl (string) - Website url will update on apple listing. This website URL will override your existing website URL on your Apple Business Connect.
            + primaryCategory (string) - Primary category of apple ,This is a mandatory field. Please pass an acceptable category name/ id by first getting the approved list using the Get category API.
            + additionalCategories (array) - You can add upto 5 additional categories most suitable for your business. Please pass an acceptable category name/ id by first getting the approved list using the Get category API.
            + appleLocationAttributes (object) - Apple connect attributes are highly visible statements about your business that appear on your Apple Business listing. Few Apple Supported attributes are:
crossbusiness.family_kids.kids_playarea, crossbusiness.barservice.happyhour Crossbusiness.attire.casual .These help your potential customers understand more about your business.
            + appleActionLinks (object) - Apple actionLinks are shown on the Apple maps place card which helps users to access or redirect to some website or app store. These are typical CTA’s that you would like to expose to your potential customers. Apple action links can only be selected from pre-defined set of action links which you can get using the GET Action links API.
        + thirdPartyListing (object) - This data will be used to update your secondary listings sites.
            + thirdPartyCategory: Towing Service (string) - Primary business category for third party listings. Note: This is a Mandatory field if vendor is applicable.
            + thirdPartySubCategories: Car Dealer, Auto Glass Shop (string) - Additional sub categories. You can set a maximum of 3 sub categories. Note: This is a Mandatory field if thirdPartyCategory is available.
        + socialProfileURLs (object) - Profile URLs for business on top rated social sites
            + facebookUrl: http://www.facebook.com/ChalkerandPetersonDental (string) - Facebook URL.
            + twitterUrl: https://twitter.com/DrsChaAndPet (string) - Business Twitter URL.
            + linkedInUrl: https://linkedin.com/DrsChaAndPet (string) - Business LinkedId URL.
            + googleUrl: https://plus.google.com/103957250846354895095/about?gl=US&hl=en-US (string)- Business Google URL.
            + youTubeUrl: https://www.youtube.com/channel/UCDNP0M75ySA5qt0So2F8Xxw (string)- Business Youtube URL.
            + instagramUrl: https://www.instagram.com/ChalkerandPetersonDental (string)- Business Instagram URL.
            + pintrestUrl - Business Pinterest URL.
            + bbbUrl - Business BB URL.
            + lendingtreeUrl - Business Lending Tree URL.
        + healthcare (object) - This section is only applicable if you have purchased the health care listings plan and have been onboarded on the same.
            + doctorCategories: Allergist-Immunologist > Allergy, Allergist-Immunologist > General (array) - This is the doctor specific category your business belongs to. Please refer to the sheet "Doctor Specific Categories" to get the possible values.
            + isProvider: true (boolean) -  If provider then select value true. If practice then select value false. This is a true/false toggle for determining if the location is a provider or not.
            + practiceName: General Medicine (string) - Name of the practice.Must be less than 191 characters.
            + firstName: John (string) -  First name of the provider.
            + middleName: Jack (string)  -  Middle name of the provider.
            + surName: Doe (string)  -  Surname of the provider
            + npi: 1245319599  (number) - National Provider Identifier - NPI. Must be 10 digits
            + credentials: MD (string) - University of the provider/practice. Must be less than 25 characters
            + university: Sample text (string) -  University of the provider/practice. Must be less than 255 characters
            + hospitalAffiliations: Sample text (string) - Hospital Affiliations of the provider/practice. Must be less than 150 characters
            + insurancesAccepted: Sample text (string) - Insurance Accepted of the provider/practice.  Must be less than 50 characters


    + Body

            {
                "businessInfo": {
                    "name": "Dieci Lifestyle Spa",
                    "phone": "(973) 716-0007",
                    "websiteUrl": "http://www.diecispa.org/",
                    "emailId": "example@birdeye.com",
                    "isAddressHidden": "No",
                    "isServiceAreaProvider": "No",
                    "mainBusinessDescription": "A cozy neighborhood café serving freshly roasted coffee, artisan teas, and homemade pastries in a friendly atmos",
                    "serviceAreas": [
                      {
                        "description": "Van An, Berryessa Road, San Jose, CA, USA"
                      },
                      {
                        "description": "Santa Clara, CA, USA"
                      }
                    ],
                    "location": {
                        "address1": "90 W Mount Pleasant Ave",
                        "address2": "(btwn Preston Dr. &amp; N. Mitchell Ave.)",
                        "city": "Livingston",
                        "state": "NJ",
                        "zip": "07039",
                        "countryCode": "US"
                    }
                },
                "additionalInfo": {
                    "establishedYear": "2022",
                    "timezone": "America/Los_Angeles",
                    "languages": [
                        "English",
                        "Hindi"
                    ],
                    "moreHours": {
                              "Dinner": [
                                {
                                  "day": 0,
                                  "isOpen": 0,
                                  "workingHours": [
                                    {
                                      "startHour": "",
                                      "endHour": ""
                                    }
                                  ]
                                },
                                {
                                  "day": 1,
                                  "isOpen": 0,
                                  "workingHours": [
                                    {
                                      "startHour": "",
                                      "endHour": ""
                                    }
                                  ]
                                },
                                {
                                  "day": 2,
                                  "isOpen": 1,
                                  "workingHours": [
                                    {
                                      "startHour": "09:00",
                                      "endHour": "20:10"
                                    }
                                  ]
                                },
                                {
                                  "day": 3,
                                  "isOpen": 1,
                                  "workingHours": [
                                    {
                                      "startHour": "09:00",
                                      "endHour": "11:30"
                                    }
                                  ]
                                },
                                {
                                  "day": 4,
                                  "isOpen": 1,
                                  "workingHours": [
                                    {
                                      "startHour": "9:00",
                                      "endHour": "11:30"
                                    }
                                  ]
                                },
                                {
                                  "day": 5,
                                  "isOpen": 1,
                                  "workingHours": [
                                    {
                                      "startHour": "09:00",
                                      "endHour": "11:30"
                                    }
                                  ]
                                },
                                {
                                  "day": 6,
                                  "isOpen": 1,
                                  "workingHours": [
                                    {
                                      "startHour": "00:00",
                                      "endHour": "20:30"
                                    }
                                  ]
                                }
                              ],
                              "Delivery": [
                                {
                                  "day": 0,
                                  "isOpen": 0,
                                  "workingHours": [
                                    {
                                      "startHour": "",
                                      "endHour": ""
                                    }
                                  ]
                                },
                                {
                                  "day": 1,
                                  "isOpen": 1,
                                  "workingHours": [
                                    {
                                      "startHour": "7:00",
                                      "endHour": "09:30"
                                    }
                                  ]
                                },
                                {
                                  "day": 2,
                                  "isOpen": 1,
                                  "workingHours": [
                                    {
                                      "startHour": "02:00",
                                      "endHour": "09:30"
                                    }
                                  ]
                                },
                                {
                                  "day": 3,
                                  "isOpen": 1,
                                  "workingHours": [
                                    {
                                      "startHour": "00:00",
                                      "endHour": "11:30"
                                    }
                                  ]
                                },
                                {
                                  "day": 4,
                                  "isOpen": 1,
                                  "workingHours": [
                                    {
                                      "startHour": "0:00",
                                      "endHour": "11:30"
                                    }
                                  ]
                                },
                                {
                                  "day": 5,
                                  "isOpen": 1,
                                  "workingHours": [
                                    {
                                      "startHour": "0:00",
                                      "endHour": "11:30"
                                    }
                                  ]
                                },
                                {
                                  "day": 6,
                                  "isOpen": 1,
                                  "workingHours": [
                                    {
                                      "startHour": "1:00",
                                      "endHour": "1:00"
                                    }
                                  ]
                                }
                              ]
                            },
                    "appleMoreHours": {
                             "Dining Hours": [
                              {
                                "day": 0,
                                "isOpen": 1,
                                "workingHours": [
                                  {
                                    "startHour": "10:00",
                                    "endHour": "16:00"
                                  }
                                ]
                              },
                              {
                                "day": 1,
                                "isOpen": 1,
                                "workingHours": [
                                  {
                                    "startHour": "10:00",
                                    "endHour": "16:00"
                                  }
                                ]
                              },
                              {
                                "day": 2,
                                "isOpen": 1,
                                "workingHours": [
                                  {
                                    "startHour": "10:00",
                                    "endHour": "16:00"
                                  }
                                ]
                              },
                              {
                                "day": 3,
                                "isOpen": 1,
                                "workingHours": [
                                  {
                                    "startHour": "10:00",
                                    "endHour": "16:00"
                                  }
                                ]
                              },
                              {
                                "day": 4,
                                "isOpen": 1,
                                "workingHours": [
                                  {
                                    "startHour": "10:00",
                                    "endHour": "16:00"
                                  }
                                ]
                              },
                              {
                                "day": 5,
                                "isOpen": 0,
                                "workingHours": [
                                  {
                                    "startHour": "",
                                    "endHour": ""
                                  }
                                ]
                              },
                              {
                                "day": 6,
                                "isOpen": 0,
                                "workingHours": [
                                  {
                                    "startHour": "",
                                    "endHour": ""
                                  }
                                ]
                              }
                          ]
                    },
                    "wholeWeekOperating": 0,
                    "hoursOfOperations": [
                        {
                            "day": 0,
                            "isOpen": 1,
                            "workingHours": [
                                {
                                    "startHour": "09:00",
                                    "endHour": "13:30"
                                },
                                {
                                    "startHour": "14:30",
                                    "endHour": "19:00"
                                }
                            ]
                        },
                        {
                            "day": 1,
                            "isOpen": 1,
                            "workingHours": [
                                {
                                    "startHour": "09:00",
                                    "endHour": "13:30"
                                },
                                {
                                    "startHour": "14:30",
                                    "endHour": "19:00"
                                }
                            ]
                        },
                        {
                            "day": 2,
                            "isOpen": 1,
                            "workingHours": [
                                {
                                    "startHour": "09:00",
                                    "endHour": "13:30"
                                },
                                {
                                    "startHour": "14:30",
                                    "endHour": "19:00"
                                }
                            ]
                        },
                        {
                            "day": 3,
                            "isOpen": 1,
                            "workingHours": [
                                {
                                    "startHour": "09:00",
                                    "endHour": "13:30"
                                },
                                {
                                    "startHour": "14:30",
                                    "endHour": "19:00"
                                }
                            ]
                        },
                        {
                            "day": 4,
                            "isOpen": 1,
                            "workingHours": [
                                {
                                    "startHour": "09:00",
                                    "endHour": "13:30"
                                },
                                {
                                    "startHour": "14:30",
                                    "endHour": "19:00"
                                }
                            ]
                        },
                        {
                            "day": 5,
                            "isOpen": 1,
                            "workingHours": [
                                {
                                    "startHour": "09:00",
                                    "endHour": "13:30"
                                },
                                {
                                    "startHour": "14:30",
                                    "endHour": "19:00"
                                }
                            ]
                        },
                        {
                            "day": 6,
                            "isOpen": 1,
                            "workingHours": [
                                {
                                    "startHour": "09:00",
                                    "endHour": "13:30"
                                },
                                {
                                    "startHour": "14:30",
                                    "endHour": "18:00"
                                }
                            ]
                        }
                    ],
                    "specialHours": [
                        {
                            "specialDate": "12/31/2020",
                            "startHour": "09:00",
                            "endHour": "12:00",
                            "isOpen": 0
                        },
                        {
                            "specialDate": "01/01/2021",
                            "startHour": "",
                            "endHour": "",
                            "isOpen": 1
                        }
                    ],
                    "businessStatus": "Open",
                    "reopenDate": "01/01/2021",
                    "keywords": "HairSalons,DaySpas,BeautySalon,BeautySalons,Salons, MassageTherapists",
                    "services": "BeautySalon,HairSpa",
                    "products": "LivingProofDryShampoo,KevinMurphyBlondeAngelWash",
                    "appointmentLink": "http://www.gmail.com",
                    "reservationLink": "http://www.gmail.com",
                    "menuLink": "http://www.gmail.com",
                    "orderAheadLink": "http://www.gmail.com",
                    "impressum": "Thisissampleimpressum",
                    "paymentTypes": ["China Union Pay","Bitcoin","Cash Accepted","MasterCard","PayPal","Check / Cheque","Contactless Payment","Debit Card","Diners Club","JCB","Financing","Visa","American Express","Cash Only","Rupay","Credit Card","Discover"],
                    "additionalPaymentTypes": "Visa,MasterCard,AmericanExpress,DebitCards,Check",
                    "localPhoneNumber": "(973)716-0102",
                    "tollFreePhoneNumber": "",
                    "iosAppURL": "http://www.gmail.com",
                    "androidAppURL": "http://www.gmail.com"
                },
                "media": {
                    "logoUrl": "https://d1py4eyp5hehj0.cloudfront.net/upload/1334812/1718082646457/2816b900140211eb870e7bf4ed6bc766.png",
                    "coverImageUrl": "https://d1py4eyp5hehj0.cloudfront.net/upload/1334812/1718082720956/GustavKlimtExpectationTreeoflifeArboldelaVidaFulfilment.jpeg",
                    "gmbCover": "https://d1py4eyp5hehj0.cloudfront.net/upload/1334812/1718082807649/41cdeb014d36cb35f936152d44c4c77d.jpeg",
                    "facebookCover": "https://d1py4eyp5hehj0.cloudfront.net/upload/1334812/1718082871068/IJ8Sa5.jpeg"
                },
                 "optOut": {
                    "gmbCoverOptOut": true,
                    "gmbLogoOptOut": true,
                    "fbCoverOptOut": false,
                    "fbLogoOptOut": false,
                    "gmbProfileOptOut": false,
                    "businessProfileOptOut": false
                },
                "covidInfo": {
                    "postDescription": "SampleCovidDesc",
                    "covid19SupportLink": "http://www.covidInfo.com",
                    "virtualCareLink": "http://www.covidInfo.com"
                },
                "bingListing": {
                    "primaryCategoryBing": "Art Restoration Service",
                    "bingDescription": "Sample Bing Description",
                    "bingCategories": [
                        "Art Restoration Service"
                    ],
                    "bingPhoneNumber": "(415) 673-0868"

                },
                 "internalListing": {
                    "description": "ipsum dolor sit amet, consectetuer adipiscing elit. Aenean commodo ligula eget dolor. Aenean massa. Cum sociis natoque penatibus et magnis dis parturient montes, nascetur ridic ipsum dolor sit amet, consectetuer adipiscing elit. Aenean commodo ligula eget dolor. Aenean massa. Cum sociis natoque penatibus et magnis dis parturient montes, nascetur ridic",
                    "category": "Beauty",
                    "subCategories": [
                        "Eyelash Service",
                        "Nail Salons"
                    ],
                    "displayCategory": "Eyelash Service"
                },
                "facebookListing": {
                    "facebookDescription": "This is sample facebook description",
                    "facebookPhoneNumber": "(415) 673-0868",
                    "categories": [
                        "Science",
                        "Sports"
                    ]
                },
                   "thirdPartyListing": {
                    "thirdPartyCategory": "Towing Service",
                    "thirdPartySubCategories": [
                        "Car Dealer",
                        "Auto Glass Shop"
                    ]
                },
                  "gmbListing": {
                    "googleWebsiteUrl": "http://www.gmail.com",
                    "googleStoreId": "1232133",
                    "googlePhoneNumber": "(973) 716-0007",
                    "primaryCategoryGmb": "Fast Food Restaurant",
                    "googleDescription": "This is sample description for google",
                    "additionalCategories": [
                        "Snack bar"
                    ],
                    "attributes": {
                        "Accessibility": [
                            {
                                "attributeId": "has_wheelchair_accessible_elevator",
                                "attributeName": "Wheelchair accessible elevator",
                                "value": false
                            }
                        ],
                        "Crowd": [
                            {
                                "attributeId": "welcomes_families",
                                "attributeName": "Family-friendly",
                                "value": true
                            }
                        ]
                    },
                    "foodDelivery":"https://www.ubereats.com",
                    "foodTakeout":"https://www.ubereats.com",
                    "whatsappBusinessLink":"https://wa.me/9737160007",
                    "textMessageNumber":"973716-0007"
                },
                 "appleListing": {
                    "primaryCategory": "health_care.dentistry.dental_clinic.dentist",
                    "appleWebsiteUrl":"https://www.apple.com",
                    "additionalCategories": [
                      "health_care.dentistry.dental_clinic.dentist.oral_surgeon"],
                   "appleLocationAttributes": {
                   "crossbusiness.accessibility_features": [{
                    "attributeId": "accessible_elevator"
                                  }
                            ],
                    "crossbusiness.family_kids": [{
                    "attributeId": "kidsclub"
                            },{
                    "attributeId": "parents_waitingarea"
                                   }
                             ]
                       },
                    "appleActionLinks": [{
                        "id": "quicklinks.schedule_appointment",
                        "deepLinkUrl": "https://www.google.com",
                        "appStoreUrl" : "https://apps.apple.com/your_apps_store_url"
                         }
                        ],
                    "phoneNumber": "+1 201-819-7989"
               },
                 "socialProfileURLs": {
                    "googleUrl": "http://www.google.com/123",
                    "facebookUrl": "http://www.facebook.com/123",
                    "twitterUrl": "http://www.twitter.com/123",
                    "youTubeUrl": "http://www.youtube.com/12",
                    "linkedinUrl": "http://www.linkedin.com/12",
                    "instagramUrl": "http://www.instagram.com/12",
                    "pintrestUrl": "http://www.pinterest.com/12",
                    "bbbUrl": "http://www.bbb.org/12",
                    "lendingtreeUrl": "http://www.lendingtree.com/12"
                },
                "healthcare": {
                    "doctorCategories": [
                        "Allergist-Immunologist > Allergy",
                        "Allergist-Immunologist > General",
                        "Addiction Medicine Specialist > General"
                    ],
                    "isProvider": true,
                    "practiceName": "General Medicine",
                    "firstName": "John",
                    "middleName": "Jack",
                    "surName": "Doe",
                    "npi": "1245319599",
                    "credentials": "MD",
                    "university": "Sample text",
                    "hospitalAffiliations": "Sample text",
                    "insurancesAccepted": "Sample text"
                }
            }



+ Response 200 (application/json)

+ Response 401

    [1161][]

+ Response 429

    [89][]

+ Response 400

    [2296][]

+ Response 400

    [2297][]

+ Response 400

    [2290][]

+ Response 400

    [3334][]

+ Response 400

    [3335][]

+ Response 400

    [3336][]

+ Response 400

    [3337][]

+ Response 400

    [3348][]

+ Response 400

    [2511][]

+ Response 400

    [2512][]

+ Response 400

    [2513][]

+ Response 400

    [2514][]

+ Response 400

    [2515][]

+ Response 400

    [2516][]

+ Response 400

    [2517][]

+ Response 400

    [2518][]

+ Response 400

    [2519][]

+ Response 400

    [2520][]

+ Response 400

    [2521][]

+ Response 400

    [2522][]

## Update Listing [/v1/listing/{businessNumber}/update]
The Update Listing API will update the location details on all your listings sites.


### Update Listing [PUT]

+ Parameters

    + businessNumber: 169744180007807 (number, required) - Business Number.

+ Request (application/json)


    + Headers

            Accept: application/json
            x-api-key: [Required] Partner specific API key provided by Birdeye for data exchange.


   + Attributes
        + businessInfo - Business Information
            + name: Drs. Chalker and Peterson, A Dental Partnership (required, string) - Name of the Business/Product (Max 250 character long).
            + phone (required, string) - Your official Business Phone number. Format is (xxx) xxx-xxxx.
            + websiteUrl: http://www.diecispa.org/ (string) - Business website url.
            + emailId: 4568@livelovespa.com (string) - Business Email ID.
            + isAddressHidden: note that this isn’t supported by all sites Possible Values  “Yes” or “No” (string) - If your business doesn’t have a place for your customers to visit, then you can hide your street address.
            + isServiceAreaProvider: Possible Values “Yes” or “No (string) - If you deliver or provide service at customer locations.
            + mainBusinessDescription: The business is a dental partnership providing general and specialized dental care services, including preventive checkups (string) - A description of the business between 200–750 characters, excluding any URLs, phone numbers, addresses, or promotional content, accurately depicting the nature of the business.
            + serviceAreas (array) - Locations where you deliver or provide service (applicable if isServiceAreaProvider is 'Yes').NOTE: Maximum service areas that can be provided are 10.
                + (object)
                    + description (string) - Area, City, State, Zip, Country. e.g.  "1735 Berryessa Rd, San Jose, CA 95133, USA", “Onalaska, WI, USA”.
            + location (object) - Business address
                + address1: 7405 Morro Rd (string) - Address of the business/location.
                + address2: Suite 102 (string) - Address of the business/location.
                + city: Atascadero (string) - City (Max 1000 character long).
                + state: CA (string) - State (2 character state code).
                + countryCode: US (string) - Country Code (2 character country code).
                + zip: 93422 (required,string) - Zip Code.
        + additionalInfo - Business Additional Information
            + establishedYear: 2012 (number) - Year established
            + timezone: America/Los_Angeles (string)- Timezone of the business.
            + languages: English, Spanish (array) - Languages.
            + moreHours (array) -  Google more hours for specific services you offer such as delivery, takeout, drive-through, and pickup (see: Supported More Hours). Google more hours can only be added if google primary category is added. To get specific types of more hours, please refer to Get supported more hours type api. NOTE: In more hours, day 0 denotes Monday, day 1 denotes Tuesday, …, day 6 denotes Sunday.
            Please refer /listing/get-more-hours-type/get-more-hours-type api to get google more hours type. Possible Values Breakfast, Lunch, Pickup, etc.
            + appleMoreHours (array) -  Apple more hours for specific services you offer such as Dining, Bar and Delivery. Apple more hours can only be added if apple primary category is added. To get specific types of apple more hours, please refer to Get supported more hours type api.  NOTE: In apple more hours, day 0 denotes Monday, day 1 denotes Tuesday, …, day 6 denotes Sunday.
            Please refer /listing/get-more-hours-type/get-more-hours-type api to get apple more hours type. Possible Values Service Hours, Delivery Service Hours, Dine In Hours etc.
            + wholeWeekOperating: 0 (number) - Whether your business is open 24/7, Possible Values - 0 or 1.
            + hoursOfOperations (array, required) - Regular hours: Regular working hours of the business for each day from Monday to Sunday.
                + (object)
                    + day: 5 (number) - 0(Monday), 1(Tuesday), 2(Wednesday) and so on.
                    + workingHours (array) - Working hours of the business
                        + (object)
                            + startHour: 7:00 (string) - Start hour 9:00 (9 AM), 18:00 (6 PM)
                            + endHour: 17:30 (string) - End hour  9:00 (9 AM), 18:00 (6 PM)
                    + isOpen: 1 (number) - 0 (Business closed today), 1 (open)
                    + comment: By appointment only (string) - Add the special instruction.
            + specialHours (array) - For special holiday days, where you may have limited hours of operation and don’t want to change your preset regular hours. These would only be applicable only for the dates they are set for.
                + (object)
                    + specialDate: 10/20/2023 (string) - It should be "MM/DD/YYYY".
                    + startHour: 7:00 (string) - Start hour 9:00 (9 AM), 18:00 (6 PM)
                    + endHour: 17:30 (string) - End hour  9:00 (9 AM), 18:00 (6 PM)
                    + isOpen: 1 (number) - 0(Business closed today), 1 (open)
            + businessStatus : Open (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 : 10/20/2022 - 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.
            + services:  Other Dental Specialties, Orthodontists, Dentistry (required,string) - Services offered by the business. Useful in SEO. (Comma separated list of services offered) Business services cannot be more than 1000 characters.
            + keywords: Dentists Atascadero CA, Other Dental Specialties Atascadero CA, Orthodontists Atascadero CA (string)- Important keywords related to the business. Useful in SEO. (Comma separated list of important keywords) Business keywords cannot be more than 1000 characters.
            + products: Invisalign, Cookies Set of 8, Brochure design & prints (string) - Products about the business. Useful in SEO and Business products cannot be more than 1000 characters.
            + appointmentLink (string) - Let customers book appointments by redirecting them to your appointments page.
            + reservationLink (string) - Let customers reserve tables by linking them to your reservations page.
            + menuLink (string) - Show customers what you serve by linking them to your menu.
            + orderAheadLink (string) - 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.
            + paymentTypes (array)
                List of payment types accepted by the business.
                + (Members)
                    + China Union Pay
                    + Bitcoin
                    + Cash Accepted
                    + MasterCard
                    + PayPal
                    + Check / Cheque
                    + Contactless Payment
                    + Debit Card
                    + Diners Club
                    + JCB
                    + Financing
                    + Visa
                    + American Express
                    + Cash Only
                    + Rupay
                    + Credit Card
                    + Discover
            + additionalPaymentTypes: Paypal, Visa, Master Card (string) - Additional Payment Type (Max 250 character long).
            + localPhoneNumber (string)- Local phone number.
            + tollFreePhoneNumber (string) - Tollfree number.
            + androidAppURL: http://www.gmail.com (string)- Android app url.
            + iosAppURL: http://www.gmail.com (string) - IOS app url.
        + media (object) - Media details.
            + logoUrl: http://d2xt3xymj142xp.cloudfront.net/712586432/other/ab60b93831ba490383b9c59c0b4cf49d.jpeg (string) - This logo will pushed to your listings sites such as Google, Facebook, Bing, Birdeye and all the other secondary listings sites. Format: JPG, JPEG, PNG. Minimum 250 x 250px. Recommended: 720 X 720 px. 10 KB min.
            + coverImageUrl: http://d2xt3xymj142xp.cloudfront.net/712586432/other/ab60b93831ba490383b9c59c0b4cf49d.jpeg (string) - This cover photo will pushed to your listings sites such as Birdeye and all the other secondary listings sites. Cover image URL for business will be displayed on custom review site.  Format: JPG, JPEG, PNG. Minimum 1110 x 374px. 10 KB min.
            + gmbCover: http://d3cnqzq0ivprch.cloudfront.net/common/css/images/profile/abcd.jpg (string) - Google Cover Image Url.
            + facebookCover: http://d3cnqzq0ivprch.cloudfront.net/common/css/images/profile/fb.jpg (string) - Facebook Cover Image Url.
        + optOut (object) - Opt out section
            + gmbLogoOptOut: true (boolean)- Update profile photo on your google my business page.
                                                    Select ‘true’ if you want to opt out from updating the logo on your GBP page.
                                                    Select ‘false’ if you want to opt in to updating the logo on your GBP page.
            + fbLogoOptOut: false (boolean) - Update profile photo on your facebook profile.
                                                    Select ‘true’ if you want to opt out from updating the logo on your FB business page.
                                                    Select ‘false’ if you want to opt in to updating the logo on your FB business page.
            + gmbCoverOptOut: true (boolean) - Update cover photo on your google my business page.
                                                    Select ‘true’ if you want to opt out from updating the cover photo on your GBP page.
                                                    Select ‘false’ if you want to opt in to updating the cover photo on your GBP page.
            + fbCoverOptOut: true (boolean) - Update cover photo on your facebook profile.
                                                    Select ‘true’ if you want to opt out from updating the cover photo on your FB business page.
                                                    Select ‘false’ if you want to opt in to updating the cover photo on your FB business page.
            + gmbProfileOptOut: false (boolean) - Opt out from the google specific section on the profile page.
                                                        Select ‘true’ if you want to opt out from updating information such as category and related attributes and more hours on your Google Business Profile page.
                                                        Select ‘false’ if you want to opt in to updating information such as category and related attributes and more hours on your Google Business Profile page.
            + businessProfileOptOut: true (boolean) - Opt out from the business profile section.
                                                            Select ‘true’ if you want to opt out from updating NAP information on your Google Business Profile page.
                                                            Select ‘false’ if you want to opt in to updating NAP information on your Google Business Profile page.
        + covidInfo (object) - Provide this data for updating any COVID specific information you want to share with your customers.
            + postDescription (string) - This information is posted and updated on your Google business profile page and your FB business page.
            + covid19SupportLink (string) - Should be a valid covid19 support url
            + virtualCareLink (string) - Should be a valid url virtual care link
        + bingListing (object) - This data will be used to update your Bing listing.
            + primaryCategoryBing (string) - Primary category of bing.
            + bingCategories (array) - You can add a maximum of up to 3 categories.
            + bingPhoneNumber (string) - You can provide a phone number which will be pushed only to your Bing listing site and will override the primary phone number set.
            + bingDescription (string) - An ‘About the business description’. Bing description cannot be more than 4096 characters.
        + internalListing (object) - Provide data for microsite listing purpose.
            + description (required, string) - An ‘about your business’ description. Business description cannot be more than 5000 characters and cannot be less than 200 characters.
            + subCategories (array) - Primary category of business.
            + subcategory (string) - You can add up to 3 subcategories.
            + displayCategory (string) - Choose one of the category either from primary category or from sub categories.
        + facebookListing (object) - This data will be used to update your Facebook business page/ listing.
            + facebookPhoneNumber (string) - Phone number for facebook profile. This phone number will override the main phone number on your Facebook business page
            + categories (array) - You can add up to 3 categories.
            + facebookDescription (string) - An ‘about your business’ description. Facebook description cannot be more than 255 characters.
        + gmbListing (object) - This data will be used to update your Google Business Profile/ listing.
            + googleWebsiteUrl (string) - Website url will update on google listing. This website URL will override your existing website URL on your Google business profile.
            + googlePhoneNumber (string) - You can provide a phone number which will be pushed only to your google listing site and will override the primary phone number set.
            + googleStoreId (string) - Store id for google.
            + primaryCategoryGmb (string) - Primary category of google.
            + additionalCategories (array) - You can add up to 9 subcategories.
            + googleDescription (string) - An ‘about your business’ description. Google description cannot be more than 750 characters.
            + attributes (object) - Google my business attributes are highly visible statements about your business that appear on your Google My Business listing. Supported attributes are
                    Accessibility,Amenities,Crowd,Dining options,Highlights,Planning,Offerings,Health & safety.
            + foodDelivery (string) - Enter the redirect URL where customers can place delivery orders.This field is applicable for hospitality business and is category dependent.Example http://www.ubereats.com
            + foodTakeout (string) - Enter the redirect URL where customers can place 'takeout' food orders. This field is applicable for hospitality business and is category dependent.Example : http://www.ubereats.com
            + whatsappBusinessLink (string) - Enter your WhatsApp Business link to display a direct chat option on your live Google Business Profile. This allows customers to easily message you. Example https://wa.me/<yourphonenumber>
            + textMessageNumber (string) - Enter a valid phone number to enable a text message chat option on your live Google Business Profile, allowing customers to easily reach you via SMS.
        + appleListing (object) - This data will be used to update your Google Business Profile/ listing.
            + phoneNumber (string) - This will be shown as the primary phoneNumber on your Apple maps place card and will replace/ override your business info phone number.
            + appleWebsiteUrl (string) - Website url will update on apple listing. This website URL will override your existing website URL on your Apple Business Connect.
            + primaryCategory (string) - Primary category of apple ,This is a mandatory field. Please pass an acceptable category name/ id by first getting the approved list using the Get category API.
            + additionalCategories (array) - You can add upto 5 additional categories most suitable for your business. Please pass an acceptable category name/ id by first getting the approved list using the Get category API.
            + appleLocationAttributes (object) - Apple connect attributes are highly visible statements about your business that appear on your Apple Business listing. Few Apple Supported attributes are:
                  crossbusiness.family_kids.kids_playarea, crossbusiness.barservice.happyhour Crossbusiness.attire.casual .These help your potential customers understand more about your business.
            + appleActionLinks (object) - Apple actionLinks are shown on the Apple maps place card which helps users to access or redirect to some website or app store. These are typical CTA’s that you would like to expose to your potential customers. Apple action links can only be selected from pre-defined set of action links which you can get using the GET Action links API.
        + thirdPartyListing (object) - This data will be used to update your secondary listings sites.
            + thirdPartyCategory: Towing Service (string) - Primary business category for third party listings. Note: This is a Mandatory field if vendor is applicable.
            + thirdPartySubCategories: Car Dealer, Auto Glass Shop (string) - Additional sub categories. You can set a maximum of 3 sub categories. Note: This is a Mandatory field if thirdPartyCategory is available.
        + socialProfileURLs (object) - Profile URLs for business on top rated social sites
            + facebookUrl: http://www.facebook.com/ChalkerandPetersonDental (string) - Facebook URL.
            + twitterUrl: https://twitter.com/DrsChaAndPet (string) - Business Twitter URL.
            + linkedInUrl: https://linkedin.com/DrsChaAndPet (string) - Business LinkedId URL.
            + googleUrl: https://plus.google.com/103957250846354895095/about?gl=US&hl=en-US (string)- Business Google URL.
            + youTubeUrl: https://www.youtube.com/channel/UCDNP0M75ySA5qt0So2F8Xxw (string)- Business Youtube URL.
            + instagramUrl: https://www.instagram.com/ChalkerandPetersonDental (string)- Business Instagram URL.
            + pintrestUrl - Business Pinterest URL.
            + bbbUrl - Business BB URL.
            + lendingtreeUrl - Business Lending Tree URL.
        + healthcare (object) - This section is only applicable if you have purchased the health care listings plan and have been onboarded on the same.
            + doctorCategories: Allergist-Immunologist > Allergy, Allergist-Immunologist > General (array) - This is the doctor specific category your business belongs to. Please refer to the sheet "Doctor Specific Categories" to get the possible values.
            + isProvider: true (boolean) -  If provider then select value true. If practice then select value false. This is a true/false toggle for determining if the location is a provider or not.
            + practiceName: General Medicine (string) - Name of the practice.Must be less than 191 characters.
            + firstName: John (string) -  First name of the provider.
            + middleName: Jack (string)  -  Middle name of the provider.
            + surName: Doe (string)  -  Surname of the provider
            + npi: 1245319599  (number) - National Provider Identifier - NPI. Must be 10 digits
            + credentials: MD (string) - University of the provider/practice. Must be less than 25 characters
            + university: Sample text (string) -  University of the provider/practice. Must be less than 255 characters
            + hospitalAffiliations: Sample text (string) - Hospital Affiliations of the provider/practice. Must be less than 150 characters
            + insurancesAccepted: Sample text (string) - Insurance Accepted of the provider/practice.  Must be less than 50 characters


    + Body

            {
                "businessInfo": {
                    "name": "Dieci Lifestyle Spa",
                    "phone": "(973) 716-0007",
                    "websiteUrl": "http://www.diecispa.org/",
                    "emailId": "example@birdeye.com",
                    "isAddressHidden": "No",
                    "isServiceAreaProvider": "No",
                    "mainBusinessDescription": "A cozy neighborhood café serving freshly roasted coffee, artisan teas, and homemade pastries in a friendly atmos",
                    "serviceAreas": [
                      {
                        "description": "Van An, Berryessa Road, San Jose, CA, USA"
                      },
                      {
                        "description": "Santa Clara, CA, USA"
                      }
                    ],
                    "location": {
                        "address1": "90 W Mount Pleasant Ave",
                        "address2": "(btwn Preston Dr. &amp; N. Mitchell Ave.)",
                        "city": "Livingston",
                        "state": "NJ",
                        "zip": "07039",
                        "countryCode": "US"
                    }
                },
                "additionalInfo": {
                    "establishedYear": "2022",
                    "timezone": "America/Los_Angeles",
                    "languages": [
                        "English",
                        "Hindi"
                    ],
                    "moreHours": {
                              "Dinner": [
                                {
                                  "day": 0,
                                  "isOpen": 0,
                                  "workingHours": [
                                    {
                                      "startHour": "",
                                      "endHour": ""
                                    }
                                  ]
                                },
                                {
                                  "day": 1,
                                  "isOpen": 0,
                                  "workingHours": [
                                    {
                                      "startHour": "",
                                      "endHour": ""
                                    }
                                  ]
                                },
                                {
                                  "day": 2,
                                  "isOpen": 1,
                                  "workingHours": [
                                    {
                                      "startHour": "09:00",
                                      "endHour": "20:10"
                                    }
                                  ]
                                },
                                {
                                  "day": 3,
                                  "isOpen": 1,
                                  "workingHours": [
                                    {
                                      "startHour": "09:00",
                                      "endHour": "11:30"
                                    }
                                  ]
                                },
                                {
                                  "day": 4,
                                  "isOpen": 1,
                                  "workingHours": [
                                    {
                                      "startHour": "9:00",
                                      "endHour": "11:30"
                                    }
                                  ]
                                },
                                {
                                  "day": 5,
                                  "isOpen": 1,
                                  "workingHours": [
                                    {
                                      "startHour": "09:00",
                                      "endHour": "11:30"
                                    }
                                  ]
                                },
                                {
                                  "day": 6,
                                  "isOpen": 1,
                                  "workingHours": [
                                    {
                                      "startHour": "00:00",
                                      "endHour": "20:30"
                                    }
                                  ]
                                }
                              ],
                              "Delivery": [
                                {
                                  "day": 0,
                                  "isOpen": 0,
                                  "workingHours": [
                                    {
                                      "startHour": "",
                                      "endHour": ""
                                    }
                                  ]
                                },
                                {
                                  "day": 1,
                                  "isOpen": 1,
                                  "workingHours": [
                                    {
                                      "startHour": "7:00",
                                      "endHour": "09:30"
                                    }
                                  ]
                                },
                                {
                                  "day": 2,
                                  "isOpen": 1,
                                  "workingHours": [
                                    {
                                      "startHour": "02:00",
                                      "endHour": "09:30"
                                    }
                                  ]
                                },
                                {
                                  "day": 3,
                                  "isOpen": 1,
                                  "workingHours": [
                                    {
                                      "startHour": "00:00",
                                      "endHour": "11:30"
                                    }
                                  ]
                                },
                                {
                                  "day": 4,
                                  "isOpen": 1,
                                  "workingHours": [
                                    {
                                      "startHour": "0:00",
                                      "endHour": "11:30"
                                    }
                                  ]
                                },
                                {
                                  "day": 5,
                                  "isOpen": 1,
                                  "workingHours": [
                                    {
                                      "startHour": "0:00",
                                      "endHour": "11:30"
                                    }
                                  ]
                                },
                                {
                                  "day": 6,
                                  "isOpen": 1,
                                  "workingHours": [
                                    {
                                      "startHour": "1:00",
                                      "endHour": "1:00"
                                    }
                                  ]
                                }
                              ]
                            },
                   "appleMoreHours": {
                             "Dining Hours": [
                              {
                                "day": 0,
                                "isOpen": 1,
                                "workingHours": [
                                  {
                                    "startHour": "10:00",
                                    "endHour": "16:00"
                                  }
                                ]
                              },
                              {
                                "day": 1,
                                "isOpen": 1,
                                "workingHours": [
                                  {
                                    "startHour": "10:00",
                                    "endHour": "16:00"
                                  }
                                ]
                              },
                              {
                                "day": 2,
                                "isOpen": 1,
                                "workingHours": [
                                  {
                                    "startHour": "10:00",
                                    "endHour": "16:00"
                                  }
                                ]
                              },
                              {
                                "day": 3,
                                "isOpen": 1,
                                "workingHours": [
                                  {
                                    "startHour": "10:00",
                                    "endHour": "16:00"
                                  }
                                ]
                              },
                              {
                                "day": 4,
                                "isOpen": 1,
                                "workingHours": [
                                  {
                                    "startHour": "10:00",
                                    "endHour": "16:00"
                                  }
                                ]
                              },
                              {
                                "day": 5,
                                "isOpen": 0,
                                "workingHours": [
                                  {
                                    "startHour": "",
                                    "endHour": ""
                                  }
                                ]
                              },
                              {
                                "day": 6,
                                "isOpen": 0,
                                "workingHours": [
                                  {
                                    "startHour": "",
                                    "endHour": ""
                                  }
                                ]
                              }
                          ]
                    },
                    "wholeWeekOperating": 0,
                    "hoursOfOperations": [
                        {
                            "day": 0,
                            "isOpen": 1,
                            "workingHours": [
                                {
                                    "startHour": "09:00",
                                    "endHour": "13:30"
                                },
                                {
                                    "startHour": "14:30",
                                    "endHour": "19:00"
                                }
                            ]
                        },
                        {
                            "day": 1,
                            "isOpen": 1,
                            "workingHours": [
                                {
                                    "startHour": "09:00",
                                    "endHour": "13:30"
                                },
                                {
                                    "startHour": "14:30",
                                    "endHour": "19:00"
                                }
                            ]
                        },
                        {
                            "day": 2,
                            "isOpen": 1,
                            "workingHours": [
                                {
                                    "startHour": "09:00",
                                    "endHour": "13:30"
                                },
                                {
                                    "startHour": "14:30",
                                    "endHour": "19:00"
                                }
                            ]
                        },
                        {
                            "day": 3,
                            "isOpen": 1,
                            "workingHours": [
                                {
                                    "startHour": "09:00",
                                    "endHour": "13:30"
                                },
                                {
                                    "startHour": "14:30",
                                    "endHour": "19:00"
                                }
                            ]
                        },
                        {
                            "day": 4,
                            "isOpen": 1,
                            "workingHours": [
                                {
                                    "startHour": "09:00",
                                    "endHour": "13:30"
                                },
                                {
                                    "startHour": "14:30",
                                    "endHour": "19:00"
                                }
                            ]
                        },
                        {
                            "day": 5,
                            "isOpen": 1,
                            "workingHours": [
                                {
                                    "startHour": "09:00",
                                    "endHour": "13:30"
                                },
                                {
                                    "startHour": "14:30",
                                    "endHour": "19:00"
                                }
                            ]
                        },
                        {
                            "day": 6,
                            "isOpen": 1,
                            "workingHours": [
                                {
                                    "startHour": "09:00",
                                    "endHour": "13:30"
                                },
                                {
                                    "startHour": "14:30",
                                    "endHour": "18:00"
                                }
                            ]
                        }
                    ],
                    "specialHours": [
                        {
                            "specialDate": "12/31/2020",
                            "startHour": "09:00",
                            "endHour": "12:00",
                            "isOpen": 0
                        },
                        {
                            "specialDate": "01/01/2021",
                            "startHour": "",
                            "endHour": "",
                            "isOpen": 1
                        }
                    ],
                    "businessStatus": "Open",
                    "reopenDate": "01/01/2021",
                    "keywords": "HairSalons,DaySpas,BeautySalon,BeautySalons,Salons, MassageTherapists",
                    "services": "BeautySalon,HairSpa",
                    "products": "LivingProofDryShampoo,KevinMurphyBlondeAngelWash",
                    "appointmentLink": "http://www.gmail.com",
                    "reservationLink": "http://www.gmail.com",
                    "menuLink": "http://www.gmail.com",
                    "orderAheadLink": "http://www.gmail.com",
                    "impressum": "Thisissampleimpressum",
                    "paymentTypes": ["China Union Pay","Bitcoin","Cash Accepted","MasterCard","PayPal","Check / Cheque","Contactless Payment","Debit Card","Diners Club","JCB","Financing","Visa","American Express","Cash Only","Rupay","Credit Card","Discover"],
                    "additionalPaymentTypes": "Visa,MasterCard,AmericanExpress,DebitCards,Check",
                    "localPhoneNumber": "(973)716-0102",
                    "tollFreePhoneNumber": "",
                    "iosAppURL": "http://www.gmail.com",
                    "androidAppURL": "http://www.gmail.com"
                },
                "media": {
                    "logoUrl": "https://d1py4eyp5hehj0.cloudfront.net/upload/1334812/1718082646457/2816b900140211eb870e7bf4ed6bc766.png",
                    "coverImageUrl": "https://d1py4eyp5hehj0.cloudfront.net/upload/1334812/1718082720956/GustavKlimtExpectationTreeoflifeArboldelaVidaFulfilment.jpeg",
                    "gmbCover": "https://d1py4eyp5hehj0.cloudfront.net/upload/1334812/1718082807649/41cdeb014d36cb35f936152d44c4c77d.jpeg",
                    "facebookCover": "https://d1py4eyp5hehj0.cloudfront.net/upload/1334812/1718082871068/IJ8Sa5.jpeg"
                },
                 "optOut": {
                    "gmbCoverOptOut": true,
                    "gmbLogoOptOut": true,
                    "fbCoverOptOut": false,
                    "fbLogoOptOut": false,
                    "gmbProfileOptOut": false,
                    "businessProfileOptOut": false
                },
                "covidInfo": {
                    "postDescription": "SampleCovidDesc",
                    "covid19SupportLink": "http://www.covidInfo.com",
                    "virtualCareLink": "http://www.covidInfo.com"
                },
                "bingListing": {
                    "primaryCategoryBing": "Art Restoration Service",
                    "bingDescription": "Sample Bing Description",
                    "bingCategories": [
                        "Art Restoration Service"
                    ],
                    "bingPhoneNumber": "(415) 673-0868"

                },
                 "internalListing": {
                    "description": "ipsum dolor sit amet, consectetuer adipiscing elit. Aenean commodo ligula eget dolor. Aenean massa. Cum sociis natoque penatibus et magnis dis parturient montes, nascetur ridic ipsum dolor sit amet, consectetuer adipiscing elit. Aenean commodo ligula eget dolor. Aenean massa. Cum sociis natoque penatibus et magnis dis parturient montes, nascetur ridic",
                    "category": "Beauty",
                    "subCategories": [
                        "Eyelash Service",
                        "Nail Salons"
                    ],
                    "displayCategory": "Eyelash Service"
                },
                "facebookListing": {
                    "facebookDescription": "This is sample facebook description",
                    "facebookPhoneNumber": "(415) 673-0868",
                    "categories": [
                        "Science",
                        "Sports"
                    ]
                },
                   "thirdPartyListing": {
                    "thirdPartyCategory": "Towing Service",
                    "thirdPartySubCategories": [
                        "Car Dealer",
                        "Auto Glass Shop"
                    ]
                },
                  "gmbListing": {
                    "googleWebsiteUrl": "http://www.gmail.com",
                    "googleStoreId": "1232133",
                    "googlePhoneNumber": "(973) 716-0007",
                    "primaryCategoryGmb": "Fast Food Restaurant",
                    "googleDescription": "This is sample description for google",
                    "additionalCategories": [
                        "Snack bar"
                    ],
                    "attributes": {
                        "Accessibility": [
                            {
                                "attributeId": "has_wheelchair_accessible_elevator",
                                "attributeName": "Wheelchair accessible elevator",
                                "value": false
                            }
                        ],
                        "Crowd": [
                            {
                                "attributeId": "welcomes_families",
                                "attributeName": "Family-friendly",
                                "value": true
                            }
                        ]
                    },
                    "foodDelivery":"https://www.ubereats.com",
                    "foodTakeout":"https://www.ubereats.com",
                    "whatsappBusinessLink":"https://wa.me/9737160007",
                    "textMessageNumber":"973716-0007"
                },
                 "appleListing": {
                    "primaryCategory": "health_care.dentistry.dental_clinic.dentist",
                    "appleWebsiteUrl":"https://www.apple.com",
                    "additionalCategories": [
                      "health_care.dentistry.dental_clinic.dentist.oral_surgeon"],
                   "appleLocationAttributes": {
                   "crossbusiness.accessibility_features": [{
                    "attributeId": "accessible_elevator"
                                  }
                            ],
                    "crossbusiness.family_kids": [{
                    "attributeId": "kidsclub"
                            },{
                    "attributeId": "parents_waitingarea"
                                   }
                             ]
                       },
                    "appleActionLinks": [{
                        "id": "quicklinks.schedule_appointment",
                        "deepLinkUrl": "https://www.google.com",
                        "appStoreUrl" : "https://apps.apple.com/your_apps_store_url"
                         }
                        ],
                    "phoneNumber": "+1 201-819-7989"
               },
                 "socialProfileURLs": {
                    "googleUrl": "http://www.google.com/123",
                    "facebookUrl": "http://www.facebook.com/123",
                    "twitterUrl": "http://www.twitter.com/123",
                    "youTubeUrl": "http://www.youtube.com/12",
                    "linkedinUrl": "http://www.linkedin.com/12",
                    "instagramUrl": "http://www.instagram.com/12",
                    "pintrestUrl": "http://www.pinterest.com/12",
                    "bbbUrl": "http://www.bbb.org/12",
                    "lendingtreeUrl": "http://www.lendingtree.com/12"
                },
                "healthcare": {
                    "doctorCategories": [
                        "Allergist-Immunologist > Allergy",
                        "Allergist-Immunologist > General",
                        "Addiction Medicine Specialist > General"
                    ],
                    "isProvider": true,
                    "practiceName": "General Medicine",
                    "firstName": "John",
                    "middleName": "Jack",
                    "surName": "Doe",
                    "npi": "1245319599",
                    "credentials": "MD",
                    "university": "Sample text",
                    "hospitalAffiliations": "Sample text",
                    "insurancesAccepted": "Sample text"
                }
            }



+ Response 200 (application/json)

+ Response 401

    [1161][]

+ Response 429

    [89][]

+ Response 400

    [2296][]

+ Response 400

    [2297][]

+ Response 400

    [2290][]

+ Response 400

    [3334][]

+ Response 400

    [3335][]

+ Response 400

    [3336][]

+ Response 400

    [3337][]

+ Response 400

    [3348][]

+ Response 400

    [2511][]

+ Response 400

    [2512][]

+ Response 400

    [2513][]

+ Response 400

    [2514][]

+ Response 400

    [2515][]

+ Response 400

    [2516][]

+ Response 400

    [2517][]

+ Response 400

    [2518][]

+ Response 400

    [2519][]

+ Response 400

    [2520][]

+ Response 400

    [2521][]

+ Response 400

    [2522][]

## Get Listing [/v1/listing/{businessNumber}/get]
The Get Listing API will get the listing information for the given business number/ ID.


### Get Listing [GET]

+ Parameters

    + businessNumber: 169744180007807 (number, required) - Business Number.

+ Request (application/json)


    + Headers

            Accept: application/json
            x-api-key: [Required] Partner specific API key provided by Birdeye for data exchange.


+ Response 200 (application/json)

   + Attributes
        + businessInfo - Business Information
            + name: Drs. Chalker and Peterson, A Dental Partnership (string) - Name of the Business/Location. Should be Max 1000 characters long.
            + phone (required, string) - Your official Business Phone number. Format is (xxx) xxx-xxxx.
            + websiteUrl: http://www.diecispa.org/ (string) - Business website url.
            + emailId: 4568@livelovespa.com (string) - Business Email ID.
            + isAddressHidden: note that this isn’t supported by all sites Possible Values  “Yes” or “No” (string) - If your business doesn’t have a place for your customers to visit, then you can hide your street address.
            + isServiceAreaProvider: Possible Values “Yes” or “No (string) - If you deliver or provide service at customer locations.
            + mainBusinessDescription: The business is a dental partnership providing general and specialized dental care services (string) - A description of the business between 200–750 characters, excluding any URLs, phone numbers, addresses, or promotional content, accurately depicting the nature of the business.
            + serviceAreas (array) - Locations where you deliver or provide service (applicable if isServiceAreaProvider is 'Yes').NOTE: Maximum service areas that can be provided are 10.
                + (object)
                    + description (string) - Area, City, State, Zip, Country. e.g.  "1735 Berryessa Rd, San Jose, CA 95133, USA", “Onalaska, WI, USA”.
                    + placeId (string) - ChIJk8EIXIG3j4ARwL_Ao3ykdeQ
            + location (object) - Business address
                + address1: 7405 Morro Rd (string) - Address of the business.
                + address2: Suite 102 (string) - Address of the business.
                + city: Atascadero (string) - City (Max 1000 character long).
                + state: CA (string) - State (2 character state code).
                + countryCode: US (string) - Country Code (2 character country code).
                + zip: 93422 (string) - Zip Code.
        + additionalInfo - Business Additional Information
            + establishedYear: 2012 (number) - Year established
            + timezone: America/Los_Angeles (string)- Timezone of the business.
            + languages: English, Spanish (array) - Languages.
            + moreHours (array) -  Google more hours for specific services you offer such as delivery, takeout, drive-through, and pickup (see: Supported More Hours). Google more hours can only be added if google primary category is added. To get specific types of more hours, please refer to Get supported more hours type api. NOTE: In more hours, day 0 denotes Monday, day 1 denotes Tuesday, …, day 6 denotes Sunday.
            Please refer /listing/get-more-hours-type/get-more-hours-type api to get google more hours type. Possible Values Breakfast, Lunch, Pickup, etc.
            + appleMoreHours (array) -  Apple more hours for specific services you offer such as Dining, Bar and Delivery. Apple more hours can only be added if apple primary category is added. To get specific types of apple more hours, please refer to Get supported more hours type api.  NOTE: In apple more hours, day 0 denotes Monday, day 1 denotes Tuesday, …, day 6 denotes Sunday.
            Please refer /listing/get-more-hours-type/get-more-hours-type api to get apple more hours type. Possible Values Service Hours, Delivery Service Hours, Dine In Hours etc.
            + wholeWeekOperating: 0 (number) - Whether your business is open 24/7, Possible Values - 0 or 1.
            + hoursOfOperations (array, required) - Regular hours: Regular working hours of the business for each day from Monday to Sunday.
                + (object)
                    + day: 5 (number) - 0(Monday), 1(Tuesday), 2(Wednesday) and so on.
                    + workingHours (array) - Working hours of the business
                        + (object)
                            + startHour: 7:00 (string) - Start hour 9:00 (9 AM), 18:00 (6 PM)
                            + endHour: 17:30 (string) - End hour  9:00 (9 AM), 18:00 (6 PM)
                    + isOpen: 1 (number) - 0 (Business closed today), 1 (open)
                    + comment: By appointment only (string) - Add the special instruction.
            + specialHours (array) - For special holiday days, where you may have limited hours of operation and don’t want to change your preset regular hours. These would only be applicable only for the dates they are set for.
                + (object)
                    + specialDate: 10/20/2023 (string) - It should be "MM/DD/YYYY".
                    + startHour: 7:00 (string) - Start hour 9:00 (9 AM), 18:00 (6 PM)
                    + endHour: 17:30 (string) - End hour  9:00 (9 AM), 18:00 (6 PM)
                    + isOpen: 1 (number) - 0(Business closed today), 1 (open)
            + businessStatus : Open (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 : 10/20/2022 - 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.
            + services:  Other Dental Specialties, Orthodontists, Dentistry (required,string) - Services offered by the business. Useful in SEO. (Comma separated list of services offered) Business services cannot be more than 1000 characters.
            + keywords: Dentists Atascadero CA, Other Dental Specialties Atascadero CA, Orthodontists Atascadero CA (string)- Important keywords related to the business. Useful in SEO. (Comma separated list of important keywords) Business keywords cannot be more than 1000 characters.
            + products: Invisalign, Cookies Set of 8, Brochure design & prints (string) - Products about the business. Useful in SEO and Business products cannot be more than 1000 characters.
            + appointmentLink (string) - Let customers book appointments by redirecting them to your appointments page.
            + reservationLink (string) - Let customers reserve tables by linking them to your reservations page.
            + menuLink (string) - Show customers what you serve by linking them to your menu.
            + orderAheadLink (string) - 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.
            + paymentTypes (array)
                List of payment types accepted by the business.
                + (Members)
                    + China Union Pay
                    + Bitcoin
                    + Cash Accepted
                    + MasterCard
                    + PayPal
                    + Check / Cheque
                    + Contactless Payment
                    + Debit Card
                    + Diners Club
                    + JCB
                    + Financing
                    + Visa
                    + American Express
                    + Cash Only
                    + Rupay
                    + Credit Card
                    + Discover
            + additionalPaymentTypes: Paypal, Visa, Master Card (string) - Additional 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.
        + media (object) - Media details.
            + logoUrl: http://d2xt3xymj142xp.cloudfront.net/712586432/other/ab60b93831ba490383b9c59c0b4cf49d.jpeg (string) - This logo will pushed to your listings sites such as Google, Facebook, Bing, Birdeye and all the other secondary listings sites. Format: JPG, JPEG, PNG. Minimum 250 x 250px. Recommended: 720 X 720 px. 10 KB min.
            + coverImageUrl: http://d2xt3xymj142xp.cloudfront.net/712586432/other/ab60b93831ba490383b9c59c0b4cf49d.jpeg (string) - This cover photo will pushed to your listings sites such as Birdeye and all the other secondary listings sites. Cover image URL for business will be displayed on custom review site.  Format: JPG, JPEG, PNG. Minimum 1110 x 374px. 10 KB min.
            + gmbCover: http://d3cnqzq0ivprch.cloudfront.net/common/css/images/profile/abcd.jpg (string) - Google Cover Image Url.
            + facebookCover: http://d3cnqzq0ivprch.cloudfront.net/common/css/images/profile/fb.jpg (string) - Facebook Cover Image Url.
        + optOut (object) - Opt out section
            + gmbLogoOptOut: true (boolean)- Update profile photo on your google my business page.
                                                    Select ‘true’ if you want to opt out from updating the logo on your GBP page.
                                                    Select ‘false’ if you want to opt in to updating the logo on your GBP page.
            + fbLogoOptOut: false (boolean) - Update profile photo on your facebook profile.
                                                    Select ‘true’ if you want to opt out from updating the logo on your FB business page.
                                                    Select ‘false’ if you want to opt in to updating the logo on your FB business page.
            + gmbCoverOptOut: true (boolean) - Update cover photo on your google my business page.
                                                    Select ‘true’ if you want to opt out from updating the cover photo on your GBP page.
                                                    Select ‘false’ if you want to opt in to updating the cover photo on your GBP page.
            + fbCoverOptOut: true (boolean) - Update cover photo on your facebook profile.
                                                    Select ‘true’ if you want to opt out from updating the cover photo on your FB business page.
                                                    Select ‘false’ if you want to opt in to updating the cover photo on your FB business page.
            + gmbProfileOptOut: false (boolean) - Opt out from the google specific section on the profile page.
                                                        Select ‘true’ if you want to opt out from updating information such as category and related attributes and more hours on your Google Business Profile page.
                                                        Select ‘false’ if you want to opt in to updating information such as category and related attributes and more hours on your Google Business Profile page.
            + businessProfileOptOut: true (boolean) - Opt out from the business profile section.
                                                            Select ‘true’ if you want to opt out from updating NAP information on your Google Business Profile page.
                                                            Select ‘false’ if you want to opt in to updating NAP information on your Google Business Profile page.
        + covidInfo (object) - Provide this data for updating any COVID specific information you want to share with your customers.
            + postDescription (string) - This information is posted and updated on your Google business profile page and your FB business page.
            + covid19SupportLink (string) - Should be a valid covid19 support url
            + virtualCareLink (string) - Should be a valid url virtual care link
        + bingListing (object) - This data will be used to update your Bing listing.
            + primaryCategoryBing (string) - Primary category of bing.
            + bingCategories (array) - You can add a maximum of up to 3 categories.
            + bingPhoneNumber (string) - You can provide a phone number which will be pushed only to your Bing listing site and will override the primary phone number set.
            + bingDescription (string) - An ‘About the business description’. Bing description cannot be more than 4096 characters.
        + internalListing (object) - Provide data for microsite listing purpose.
            + description (required, string) - An ‘about your business’ description. Business description cannot be more than 5000 characters and cannot be less than 200 characters.
            + subCategories (array) - Primary category of business.
            + subcategory (string) - You can add up to 3 subcategories.
            + displayCategory (string) - Choose one of the category either from primary category or from sub categories.
        + facebookListing (object) - This data will be used to update your Facebook business page/ listing.
            + facebookPhoneNumber (string) - Phone number for facebook profile. This phone number will override the main phone number on your Facebook business page
            + categories (array) - You can add up to 3 categories.
            + facebookDescription (string) - An ‘about your business’ description. Facebook description cannot be more than 255 characters.
        + gmbListing (object) - This data will be used to update your Google Business Profile/ listing.
            + googleWebsiteUrl (string) - Website url will update on google listing. This website URL will override your existing website URL on your Google business profile.
            + googlePhoneNumber (string) - You can provide a phone number which will be pushed only to your google listing site and will override the primary phone number set.
            + googleStoreId (string) - Store id for google.
            + primaryCategoryGmb (string) - Primary category of google.
            + additionalCategories (array) - You can add up to 9 subcategories.
            + googleDescription (string) - An ‘about your business’ description. Google description cannot be more than 750 characters.
            + attributes (object) - Google my business attributes are highly visible statements about your business that appear on your Google My Business listing. Supported attributes are
                    Accessibility,Amenities,Crowd,Dining options,Highlights,Planning,Offerings,Health & safety.
            + foodDelivery (string) - Enter the redirect URL where customers can place delivery orders.This field is applicable for hospitality business and is category dependent.Example http://www.ubereats.com
            + foodTakeout (string) - Enter the redirect URL where customers can place 'takeout' food orders. This field is applicable for hospitality business and is category dependent.Example : http://www.ubereats.com
            + whatsappBusinessLink (string) - Enter your WhatsApp Business link to display a direct chat option on your live Google Business Profile. This allows customers to easily message you. Example https://wa.me/<yourphonenumber>
            + textMessageNumber (string) - Enter a valid phone number to enable a text message chat option on your live Google Business Profile, allowing customers to easily reach you via SMS.
        + appleListing (object) - This data will be used to update your Google Business Profile/ listing.
            + phoneNumber (string) - This will be shown as the primary phoneNumber on your Apple maps place card and will replace/ override your business info phone number.
            + appleWebsiteUrl (string) - Website url will update on apple listing. This website URL will override your existing website URL on your Apple Business Connect.
            + primaryCategory (string) - Primary category Id for Apple.
            + additionalCategories (array) - Additional categories Id for Apple.
            + primaryCategoryName (string) - Primary category Name for Apple.
            + additionalCategoriesNames (array) - Additional categories Name for Apple.
            + appleLocationAttributes (object) - Apple connect attributes are highly visible statements about your business that appear on your Apple Business listing. Few Apple Supported attributes are:
               crossbusiness.family_kids.kids_playarea, crossbusiness.barservice.happyhour Crossbusiness.attire.casual .These help your potential customers understand more about your business.
            + appleActionLinks (object) - Apple actionLinks are shown on the Apple maps place card which helps users to access or redirect to some website or app store. These are typical CTA’s that you would like to expose to your potential customers. Apple action links can only be selected from pre-defined set of action links which you can get using the GET Action links API.
        + thirdPartyListing (object) - This data will be used to update your secondary listings sites.
            + thirdPartyCategory: Towing Service (string) - Primary business category for third party listings. Note: This is a Mandatory field if vendor is applicable.
            + thirdPartySubCategories: Car Dealer, Auto Glass Shop (string) - Additional sub categories. You can set a maximum of 3 sub categories. Note: This is a Mandatory field if thirdPartyCategory is available.
        + socialProfileURLs (object) - Profile URLs for business on top rated social sites
            + facebookUrl: http://www.facebook.com/ChalkerandPetersonDental (string) - Facebook URL.
            + twitterUrl: https://twitter.com/DrsChaAndPet (string) - Business Twitter URL.
            + linkedInUrl: https://linkedin.com/DrsChaAndPet (string) - Business LinkedId URL.
            + googleUrl: https://plus.google.com/103957250846354895095/about?gl=US&hl=en-US (string)- Business Google URL.
            + youTubeUrl: https://www.youtube.com/channel/UCDNP0M75ySA5qt0So2F8Xxw (string)- Business Youtube URL.
            + pintrestUrl - Business Pinterest URL.
            + bbbUrl - Business BB URL.
            + lendingtreeUrl - Business Lending Tree URL.
        + healthcare (object) - This section is only applicable if you have purchased the health care listings plan and have been onboarded on the same.
            + doctorCategories: Allergist-Immunologist > Allergy, Allergist-Immunologist > General (array) - This is the doctor specific category your business belongs to. Please refer to the sheet "Doctor Specific Categories" to get the possible values.
            + isProvider: true (boolean) -  If provider then select value true. If practice then select value false. This is a true/false toggle for determining if the location is a provider or not.
            + practiceName: General Medicine (string) - Name of the practice.Must be less than 191 characters.
            + firstName: John (string) -  First name of the provider.
            + middleName: Jack (string)  -  Middle name of the provider.
            + surName: Doe (string)  -  Surname of the provider
            + npi: 1245319599  (number) - National Provider Identifier - NPI. Must be 10 digits
            + credentials: MD (string) - University of the provider/practice. Must be less than 25 characters
            + university: Sample text (string) -  University of the provider/practice. Must be less than 255 characters
            + hospitalAffiliations: Sample text (string) - Hospital Affiliations of the provider/practice. Must be less than 150 characters
            + insurancesAccepted: Sample text (string) - Insurance Accepted of the provider/practice.  Must be less than 50 characters


    + Body

             {
                "businessInfo": {
                    "name": "Dieci Lifestyle Spa",
                    "phone": "(973) 716-0007",
                    "websiteUrl": "http://www.diecispa.org/",
                    "emailId": "example@birdeye.com",
                    "isAddressHidden": "No",
                    "isServiceAreaProvider": "No",
                    "mainBusinessDescription": "A cozy neighborhood café serving freshly roasted coffee, artisan teas, and homemade pastries in a friendly atmos",
                    "serviceAreas": [
                      {
                        "description": "Van An, Berryessa Road, San Jose, CA, USA"
                      },
                      {
                        "description": "Santa Clara, CA, USA"
                      }
                    ],
                    "location": {
                        "address1": "90 W Mount Pleasant Ave",
                        "address2": "(btwn Preston Dr. &amp; N. Mitchell Ave.)",
                        "city": "Livingston",
                        "state": "NJ",
                        "zip": "07039",
                        "countryCode": "US"
                    }
                },
                "additionalInfo": {
                    "establishedYear": "2022",
                    "timezone": "America/Los_Angeles",
                    "languages": [
                        "English",
                        "Hindi"
                    ],
                    "moreHours": {
                              "Dinner": [
                                {
                                  "day": 0,
                                  "isOpen": 0,
                                  "workingHours": [
                                    {
                                      "startHour": "",
                                      "endHour": ""
                                    }
                                  ]
                                },
                                {
                                  "day": 1,
                                  "isOpen": 0,
                                  "workingHours": [
                                    {
                                      "startHour": "",
                                      "endHour": ""
                                    }
                                  ]
                                },
                                {
                                  "day": 2,
                                  "isOpen": 1,
                                  "workingHours": [
                                    {
                                      "startHour": "09:00",
                                      "endHour": "20:10"
                                    }
                                  ]
                                },
                                {
                                  "day": 3,
                                  "isOpen": 1,
                                  "workingHours": [
                                    {
                                      "startHour": "09:00",
                                      "endHour": "11:30"
                                    }
                                  ]
                                },
                                {
                                  "day": 4,
                                  "isOpen": 1,
                                  "workingHours": [
                                    {
                                      "startHour": "9:00",
                                      "endHour": "11:30"
                                    }
                                  ]
                                },
                                {
                                  "day": 5,
                                  "isOpen": 1,
                                  "workingHours": [
                                    {
                                      "startHour": "09:00",
                                      "endHour": "11:30"
                                    }
                                  ]
                                },
                                {
                                  "day": 6,
                                  "isOpen": 1,
                                  "workingHours": [
                                    {
                                      "startHour": "00:00",
                                      "endHour": "20:30"
                                    }
                                  ]
                                }
                              ],
                              "Delivery": [
                                {
                                  "day": 0,
                                  "isOpen": 0,
                                  "workingHours": [
                                    {
                                      "startHour": "",
                                      "endHour": ""
                                    }
                                  ]
                                },
                                {
                                  "day": 1,
                                  "isOpen": 1,
                                  "workingHours": [
                                    {
                                      "startHour": "7:00",
                                      "endHour": "09:30"
                                    }
                                  ]
                                },
                                {
                                  "day": 2,
                                  "isOpen": 1,
                                  "workingHours": [
                                    {
                                      "startHour": "02:00",
                                      "endHour": "09:30"
                                    }
                                  ]
                                },
                                {
                                  "day": 3,
                                  "isOpen": 1,
                                  "workingHours": [
                                    {
                                      "startHour": "00:00",
                                      "endHour": "11:30"
                                    }
                                  ]
                                },
                                {
                                  "day": 4,
                                  "isOpen": 1,
                                  "workingHours": [
                                    {
                                      "startHour": "0:00",
                                      "endHour": "11:30"
                                    }
                                  ]
                                },
                                {
                                  "day": 5,
                                  "isOpen": 1,
                                  "workingHours": [
                                    {
                                      "startHour": "0:00",
                                      "endHour": "11:30"
                                    }
                                  ]
                                },
                                {
                                  "day": 6,
                                  "isOpen": 1,
                                  "workingHours": [
                                    {
                                      "startHour": "1:00",
                                      "endHour": "1:00"
                                    }
                                  ]
                                }
                              ]
                            },
                    "appleMoreHours": {
                             "Dining Hours": [
                              {
                                "day": 0,
                                "isOpen": 1,
                                "workingHours": [
                                  {
                                    "startHour": "10:00",
                                    "endHour": "16:00"
                                  }
                                ]
                              },
                              {
                                "day": 1,
                                "isOpen": 1,
                                "workingHours": [
                                  {
                                    "startHour": "10:00",
                                    "endHour": "16:00"
                                  }
                                ]
                              },
                              {
                                "day": 2,
                                "isOpen": 1,
                                "workingHours": [
                                  {
                                    "startHour": "10:00",
                                    "endHour": "16:00"
                                  }
                                ]
                              },
                              {
                                "day": 3,
                                "isOpen": 1,
                                "workingHours": [
                                  {
                                    "startHour": "10:00",
                                    "endHour": "16:00"
                                  }
                                ]
                              },
                              {
                                "day": 4,
                                "isOpen": 1,
                                "workingHours": [
                                  {
                                    "startHour": "10:00",
                                    "endHour": "16:00"
                                  }
                                ]
                              },
                              {
                                "day": 5,
                                "isOpen": 0,
                                "workingHours": [
                                  {
                                    "startHour": "",
                                    "endHour": ""
                                  }
                                ]
                              },
                              {
                                "day": 6,
                                "isOpen": 0,
                                "workingHours": [
                                  {
                                    "startHour": "",
                                    "endHour": ""
                                  }
                                ]
                              }
                          ]
                    },
                    "wholeWeekOperating": 0,
                    "hoursOfOperations": [
                        {
                            "day": 0,
                            "isOpen": 1,
                            "workingHours": [
                                {
                                    "startHour": "09:00",
                                    "endHour": "13:30"
                                },
                                {
                                    "startHour": "14:30",
                                    "endHour": "19:00"
                                }
                            ]
                        },
                        {
                            "day": 1,
                            "isOpen": 1,
                            "workingHours": [
                                {
                                    "startHour": "09:00",
                                    "endHour": "13:30"
                                },
                                {
                                    "startHour": "14:30",
                                    "endHour": "19:00"
                                }
                            ]
                        },
                        {
                            "day": 2,
                            "isOpen": 1,
                            "workingHours": [
                                {
                                    "startHour": "09:00",
                                    "endHour": "13:30"
                                },
                                {
                                    "startHour": "14:30",
                                    "endHour": "19:00"
                                }
                            ]
                        },
                        {
                            "day": 3,
                            "isOpen": 1,
                            "workingHours": [
                                {
                                    "startHour": "09:00",
                                    "endHour": "13:30"
                                },
                                {
                                    "startHour": "14:30",
                                    "endHour": "19:00"
                                }
                            ]
                        },
                        {
                            "day": 4,
                            "isOpen": 1,
                            "workingHours": [
                                {
                                    "startHour": "09:00",
                                    "endHour": "13:30"
                                },
                                {
                                    "startHour": "14:30",
                                    "endHour": "19:00"
                                }
                            ]
                        },
                        {
                            "day": 5,
                            "isOpen": 1,
                            "workingHours": [
                                {
                                    "startHour": "09:00",
                                    "endHour": "13:30"
                                },
                                {
                                    "startHour": "14:30",
                                    "endHour": "19:00"
                                }
                            ]
                        },
                        {
                            "day": 6,
                            "isOpen": 1,
                            "workingHours": [
                                {
                                    "startHour": "09:00",
                                    "endHour": "13:30"
                                },
                                {
                                    "startHour": "14:30",
                                    "endHour": "18:00"
                                }
                            ]
                        }
                    ],
                    "specialHours": [
                        {
                            "specialDate": "12/31/2020",
                            "startHour": "09:00",
                            "endHour": "12:00",
                            "isOpen": 0
                        },
                        {
                            "specialDate": "01/01/2021",
                            "startHour": "",
                            "endHour": "",
                            "isOpen": 1
                        }
                    ],
                    "businessStatus": "Open",
                    "reopenDate": "01/01/2021",
                    "keywords": "HairSalons,DaySpas,BeautySalon,BeautySalons,Salons, MassageTherapists",
                    "services": "BeautySalon,HairSpa",
                    "products": "LivingProofDryShampoo,KevinMurphyBlondeAngelWash",
                    "appointmentLink": "http://www.gmail.com",
                    "reservationLink": "http://www.gmail.com",
                    "menuLink": "http://www.gmail.com",
                    "orderAheadLink": "http://www.gmail.com",
                    "impressum": "Thisissampleimpressum",
                    "paymentTypes": ["China Union Pay","Bitcoin","Cash Accepted","MasterCard","PayPal","Check / Cheque","Contactless Payment","Debit Card","Diners Club","JCB","Financing","Visa","American Express","Cash Only","Rupay","Credit Card","Discover"],
                    "additionalPaymentTypes": "Visa,MasterCard,AmericanExpress,DebitCards,Check",
                    "localPhoneNumber": "(973)716-0102",
                    "tollFreePhoneNumber": "",
                    "iosAppURL": "http://www.gmail.com",
                    "androidAppURL": "http://www.gmail.com"
                },
                "media": {
                    "logoUrl": "https://d1py4eyp5hehj0.cloudfront.net/upload/1334812/1718082646457/2816b900140211eb870e7bf4ed6bc766.png",
                    "coverImageUrl": "https://d1py4eyp5hehj0.cloudfront.net/upload/1334812/1718082720956/GustavKlimtExpectationTreeoflifeArboldelaVidaFulfilment.jpeg",
                    "gmbCover": "https://d1py4eyp5hehj0.cloudfront.net/upload/1334812/1718082807649/41cdeb014d36cb35f936152d44c4c77d.jpeg",
                    "facebookCover": "https://d1py4eyp5hehj0.cloudfront.net/upload/1334812/1718082871068/IJ8Sa5.jpeg"
                },
                 "optOut": {
                    "gmbCoverOptOut": true,
                    "gmbLogoOptOut": true,
                    "fbCoverOptOut": false,
                    "fbLogoOptOut": false,
                    "gmbProfileOptOut": false,
                    "businessProfileOptOut": false
                },
                "covidInfo": {
                    "postDescription": "SampleCovidDesc",
                    "covid19SupportLink": "http://www.covidInfo.com",
                    "virtualCareLink": "http://www.covidInfo.com"
                },
                "bingListing": {
                    "primaryCategoryBing": "Art Restoration Service",
                    "bingDescription": "Sample Bing Description",
                    "bingCategories": [
                        "Art Restoration Service"
                    ],
                    "bingPhoneNumber": "(415) 673-0868"

                },
                 "internalListing": {
                    "description": "ipsum dolor sit amet, consectetuer adipiscing elit. Aenean commodo ligula eget dolor. Aenean massa. Cum sociis natoque penatibus et magnis dis parturient montes, nascetur ridic ipsum dolor sit amet, consectetuer adipiscing elit. Aenean commodo ligula eget dolor. Aenean massa. Cum sociis natoque penatibus et magnis dis parturient montes, nascetur ridic",
                    "category": "Beauty",
                    "subCategories": [
                        "Eyelash Service",
                        "Nail Salons"
                    ],
                    "displayCategory": "Eyelash Service"
                },
                "facebookListing": {
                    "facebookDescription": "This is sample facebook description",
                    "facebookPhoneNumber": "(415) 673-0868",
                    "categories": [
                        "Science",
                        "Sports"
                    ]
                },
                   "thirdPartyListing": {
                    "thirdPartyCategory": "Towing Service",
                    "thirdPartySubCategories": [
                        "Car Dealer",
                        "Auto Glass Shop"
                    ]
                },
                  "gmbListing": {
                    "googleWebsiteUrl": "http://www.gmail.com",
                    "googleStoreId": "1232133",
                    "googlePhoneNumber": "(973) 716-0007",
                    "primaryCategoryGmb": "Fast Food Restaurant",
                    "googleDescription": "This is sample description for google",
                    "additionalCategories": [
                        "Snack bar"
                    ],
                    "attributes": {
                        "Accessibility": [
                            {
                                "attributeId": "has_wheelchair_accessible_elevator",
                                "attributeName": "Wheelchair accessible elevator",
                                "value": false
                            }
                        ],
                        "Crowd": [
                            {
                                "attributeId": "welcomes_families",
                                "attributeName": "Family-friendly",
                                "value": true
                            }
                        ]
                    },
                    "foodDelivery":"https://www.ubereats.com",
                    "foodTakeout":"https://www.ubereats.com",
                    "whatsappBusinessLink":"https://wa.me/9737160007",
                    "textMessageNumber":"973716-0007"
                },
                 "appleListing": {
                    "primaryCategory": "health_care.dentistry.dental_clinic.dentist",
                    "primaryCategoryName": "Dentist",
                    "appleWebsiteUrl":"https://www.apple.com",
                    "additionalCategories": [
                                "health_care.dentistry.dental_clinic.dentist.oral_surgeon"
                        ],
                    "additionalCategoriesNames": [
                                "Oral Surgeon"
                        ],
                   "appleLocationAttributes": {
                   "crossbusiness.accessibility_features": [{
                    "attributeId": "accessible_elevator"
                                  }
                            ],
                    "crossbusiness.family_kids": [{
                    "attributeId": "kidsclub"
                            },{
                    "attributeId": "parents_waitingarea"
                                   }
                             ]
                       },
                    "appleActionLinks": [{
                        "id": "quicklinks.schedule_appointment",
                        "deepLinkUrl": "https://www.google.com",
                        "appStoreUrl" : "https://apps.apple.com/your_apps_store_url"
                         }
                        ],
                    "phoneNumber": "+1 201-819-7989"
               },
                 "socialProfileURLs": {
                    "googleUrl": "http://www.google.com/123",
                    "facebookUrl": "http://www.facebook.com/123",
                    "twitterUrl": "http://www.twitter.com/123",
                    "youTubeUrl": "http://www.youtube.com/12",
                    "linkedinUrl": "http://www.linkedin.com/12",
                    "instagramUrl": "http://www.instagram.com/12",
                    "pintrestUrl": "http://www.pinterest.com/12",
                    "bbbUrl": "http://www.bbb.org/12",
                    "lendingtreeUrl": "http://www.lendingtree.com/12"
                },
                "healthcare": {
                    "doctorCategories": [
                        "Allergist-Immunologist > Allergy",
                        "Allergist-Immunologist > General",
                        "Addiction Medicine Specialist > General"
                    ],
                    "isProvider": true,
                    "practiceName": "General Medicine",
                    "firstName": "John",
                    "middleName": "Jack",
                    "surName": "Doe",
                    "npi": "1245319599",
                    "credentials": "MD",
                    "university": "Sample text",
                    "hospitalAffiliations": "Sample text",
                    "insurancesAccepted": "Sample text"
                }
            }


+ Response 401

    [1161][]

+ Response 429

    [89][]

## Get More Hours Type [/v1/listing/{businessNumber}/more-hours-type{?channel}]
Get supported more hours type for a location. This will depend on the country and gmb primary category for the particular location.

### Get More Hours Type [GET]

+ Parameters

    + businessNumber: 169744180007807 (number, required) - Business Number.

    + channel: gmb (string) -  Source name for which more hours type needs to be fetched. Possible values are gmb, apple. Default value will be gmb if not passed

+ Request (application/json)


    + Headers

            Accept: application/json
            x-api-key: [Required] Partner specific API key provided by Birdeye for data exchange.


+ Response 200

   + Attributes (array)
        + (object)

    + Body

            [
              "Access",
              "Breakfast",
              "Brunch",
              "Delivery",
              "Dinner",
              "Drive through",
              "Happy hours",
              "Kitchen",
              "Lunch",
              "Online service hours",
              "Pickup",
              "Takeout",
              "Senior hours"
            ]




+ Response 401

    [1161][]

+ Response 429

    [89][]


+ Response 400

    [4014][]

+ Response 400

    [4012][]

+ Response 400

    [4013][]

+ Response 400

    [4015][]

## Get Google Keywords Count [/v1/listing/{businessNumber}/gmb/keywords]
Get’s Google keywords count for an account.
Google keyword: Top keywords searched for which your business is ranked.


### Get Google Keywords Count [POST]

+ Parameters

    + businessNumber: 169744180007807 (string, required) - Account Business Number.


+ Request (application/json)

    + Headers

            Accept: application/json
            x-api-key: - Partner specific API key provided by Birdeye for data exchange.

    + Attributes
        + selectedMonth: Oct 2023,NOV 2023 (array , required ) - Filter months for which keyword data is required
        + selectedkeywords: prom (array) - Gives you keyword count for the selected keywords. keywordsSearch: To search by keywords that may also exist in search phrases, including the keyword itself.
        + keywordsSearch (string) - To search by keywords that may also exist in search phrases, including the keyword itself.
        + limit: 25 (number) - Specify number of records to return.
        + startIndex: 0 (number) - Index to start search from. Default value 0.
        + sortby: frequency (string) - Possible values “frequency” or “keyword”.
        + order: desc (string) - Possible values “asc” or “desc”.
        + businessNumbers: 123456789, 987656789 (array) - list of the unique business ids associated with a business.


    + Body

            {
                  "businessNumbers": [147286063579104,147286063579108],
                  "selectedMonth": [
                    "Oct 2023",
                    "Sep 2023",
                    "Nov 2023"
                  ],
                  "limit": 25,
                  "startIndex": 0,
                  "selectedkeywords": [
                    "prom"
                  ],
                  "sortby": "frequency",
                  "order": "desc",
                  "keywordsSearch": "prom dresses"
            }


+ Response 200

    + Attributes
        + data (array) - Returns business/location name along with its keywords count.
            + (object)
                + label: Total (string)  - Business/location name. Total, for sum of all locations keyword count
                + frequency: 50909 (string)  - Keywords count

    + Body

            {
                  "data": [
                    {
                      "label": "Total",
                      "frequency": 50909
                    },
                    {
                      "label": "prom dresses near me",
                      "frequency": 19156
                    },
                    {
                      "label": "prom dresses",
                      "frequency": 6168
                    },
                    {
                      "label": "david's bridal prom dresses",
                      "frequency": 3642
                    },
                    {
                      "label": "davids bridal prom dresses",
                      "frequency": 1005
                    },
                    {
                      "label": "prom dresses nearby",
                      "frequency": 825
                    }
                  ],
                  "totalKeywordCount": 734
            }

+ Response 401

    [1161][]

+ Response 429

    [89][]

+ Response 404

    [1011][]

+ Response 401

    [1167][]

+ Response 400

    [2457][]

+ Response 400

    [2458][]

## Deactivate Listing [/v1/listing/{businessNumber}/deactivate]
Deactivate Listing API stops publishing any information on the given online directories/ listings sites (as per your plan/ package chosen).

> __Note__
> - If you want to reactivate posting to / update your listing sites after you have deactivated, you will need to use either of create Listings or Fix Listings API.

### Deactivate Listing [POST]

+ Parameters

    + businessNumber: 169744180007807 (number, required) - Business Number.

+ Request (application/json)


    + Headers

            Accept: application/json
            x-api-key: [Required] Partner specific API key provided by Birdeye for data exchange.


+ Response 200 (application/json)

+ Response 401

    [1161][]

+ Response 429

    [89][]

## Retrieve Menu Details [/v1/listing/menu-details]
This API retrieves structured menu information for specified business numbers.

### Retrieve Menu Details [POST]

+ Request (application/json)

    + Headers

            Accept: application/json
            x-api-key: [Required] Partner specific API key provided by Birdeye for data exchange.
            x-business-number: [Required] User associated businessNumber

    + Attributes

        + businessNumbers: 175009059995828,169028735563867 (array) - Location numbers of enterprise locations. If empty all valid enterprise locations will be selected.

    + Body

            {
                "businessNumbers": [
                    175009059995828,
                    169028735563867,
                    166609110899853,
                    164873686901155,
                    164863775654389,
                    164847076003414
                ]
            }

+ Response 200 (application/json)

    + Attributes (array)
        + (object)
            + id: abc123 (string) - Unique identifier of the record
            + businessNumber: 1210543123123 (number) - Unique business ID
            + accountNumber: 1191304123 (number) - Account ID associated with the business
            + menuDetails (object)
                + name: Restaurant Name (string) - Business display name
                + error: null (string, optional) - Error details if retrieval failed
                + menus (array)
                    + (object)
                        + cuisines (array[string]) - List of cuisines served
                            + Italian
                            + Continental
                        + labels (array)
                            + (object)
                                + displayName: Main Menu (string)
                                + description: Our signature dishes (string)
                                + languageCode: en (string)
                        + sections (array)
                            + (object)
                                + labels (array)
                                    + (object)
                                        + displayName: Appetizers (string)
                                        + description: Starters (string)
                                        + languageCode: en (string)
                                + items (array)
                                    + (object)
                                        + labels (array)
                                            + (object)
                                                + displayName: Bruschetta (string)
                                                + description: Toasted bread with toppings (string)
                                                + languageCode: en (string)
                                        + attributes (object)
                                            + price (object)
                                                + currencyCode: USD (string)
                                                + units: 7 (number)
                                                + nanos: 500000000 (number)
                                            + allergen (array[string])
                                                + Gluten
                                            + dietaryRestriction (array[string])
                                                + Vegetarian
                                            + nutritionFacts (object)
                                                + calories: 150 (number)
                                                + fatContent: 5g (string)
                                                + proteinContent: 3g (string)
                                                + carbohydrateContent: 20g (string)
                                            + ingredients (array)
                                                + (object)
                                                    + name: Bread (string)
                                                + (object)
                                                    + name: Tomato (string)
                                            + servesNumPeople: 2 (number)
                                            + preparationMethods (array[string])
                                                + Grilled
                                            + portionSize (object)
                                                + amount: 150 (number)
                                                + unit: grams (string)
                                            + mediaKeys (array)
                                        + options (array)
                                            + (object)
                                                + labels (array)
                                                    + (object)
                                                        + displayName: Extra Cheese (string)
                                                        + description: null (string, optional)
                                                        + languageCode: en (string)
                                                + attributes (object)
                                                    + price (object)
                                                        + currencyCode: USD (string)
                                                        + units: 2 (number)
                                                        + nanos: 0 (number)
                + businessNumber: 1210543 (number)
                + correlationId: xyz-456 (string)
            + createdAt: 2025-07-23T07:51:56.889Z (string) - Creation timestamp
            + updatedAt: 2025-07-24T10:11:22.456Z (string) - Last update timestamp
            + crmName: BirdeyeCRM (string)

    + Body

            [
                {
                    "id": "abc123",
                    "businessNumber": 1210543123123,
                    "accountNumber": 1191304123,
                    "menuDetails": {
                        "name": "Restaurant Name",
                        "error": null,
                        "menus": [
                            {
                                "cuisines": ["Italian", "Continental"],
                                "labels": [
                                    {
                                        "displayName": "Main Menu",
                                        "description": "Our signature dishes",
                                        "languageCode": "en"
                                    }
                                ],
                                "sections": [
                                    {
                                        "labels": [
                                            {
                                                "displayName": "Appetizers",
                                                "description": "Starters",
                                                "languageCode": "en"
                                            }
                                        ],
                                        "items": [
                                            {
                                                "labels": [
                                                    {
                                                        "displayName": "Bruschetta",
                                                        "description": "Toasted bread with toppings",
                                                        "languageCode": "en"
                                                    }
                                                ],
                                                "attributes": {
                                                    "price": {
                                                        "currencyCode": "USD",
                                                        "units": 7,
                                                        "nanos": 500000000
                                                    },
                                                    "allergen": ["Gluten"],
                                                    "dietaryRestriction": ["Vegetarian"],
                                                    "nutritionFacts": {
                                                        "calories": 150,
                                                        "fatContent": "5g",
                                                        "proteinContent": "3g",
                                                        "carbohydrateContent": "20g"
                                                    },
                                                    "ingredients": [
                                                        { "name": "Bread" },
                                                        { "name": "Tomato" }
                                                    ],
                                                    "servesNumPeople": 2,
                                                    "preparationMethods": ["Grilled"],
                                                    "portionSize": {
                                                        "amount": 150,
                                                        "unit": "grams"
                                                    },
                                                    "mediaKeys": []
                                                },
                                                "options": [
                                                    {
                                                        "labels": [
                                                            {
                                                                "displayName": "Extra Cheese",
                                                                "description": null,
                                                                "languageCode": "en"
                                                            }
                                                        ],
                                                        "attributes": {
                                                            "price": {
                                                                "currencyCode": "USD",
                                                                "units": 2,
                                                                "nanos": 0
                                                            }
                                                        }
                                                    }
                                                ]
                                            }
                                        ]
                                    }
                                ]
                            }
                        ],
                        "businessNumber": 1210543,
                        "correlationId": "xyz-456"
                    },
                    "createdAt": "2025-07-23T07:51:56.889Z",
                    "updatedAt": "2025-07-24T10:11:22.456Z",
                    "crmName": "BirdeyeCRM"
                }
            ]


+ Response 401

    [1161][]

+ Response 429

    [89][]

+ Response 404

    [1011][]

+ Response 401

    [1167][]

+ Response 400

    [2457][]

+ Response 400

    [2458][]

# Group GMB Products
To manage products, locations, and business details through Listing GMB platform

## Onboard Google Merchant Account [/v1/listing/public/product/setup/googleMerchant{?merchantId}]
Onboards/connects a Google Merchant account for products listing.

### Onboard Google Merchant Account [POST]

+ Parameters

    + merchantId: 1234567 (string, required) - Google Merchant Center account ID.

+ Request (application/json)

    + Headers

            Accept: application/json
            x-api-key: [Required] Partner specific API key provided by Birdeye for data exchange.
            x-business-number: [Required] User assosiated businessNumber

    + Body

            {}

+ Response 200 (application/json)

    + Attributes
        + code: 200 (number)
        + message: String (string)

    + Body

            {
              "code": 200,
              "message": "String"
            }

+ Response 401

    [1161][]

+ Response 429

    [89][]

+ Response 404

    [1011][]

+ Response 401

    [1167][]


## Create Product Listing [/v1/listing/public/product]
Creates a product listing on the Google Merchant account linked to the Birdeye account.

### Create Product Listing [POST]

+ Request (application/json)

    + Headers

            Accept: application/json
            x-api-key: [Required] Partner specific API key provided by Birdeye for data exchange.
            x-business-number: [Required] User assosiated businessNumber

    + Attributes

        + businessNumbers: 145308764185002,145308769721320 (array) - Location numbers of enterprise locations. If empty all valid enterprise locations will be selected.
        + title: Dental Implant (string, required) - Product title.
        + description: The dental procedure for replacing missing teeth using implants. (string, optional)
        + imageLink: https://example.com/images/dentalImplantMain.jpg (string, required) - Publicly accessible image URL.
        + additionalImageLinks: https://example.com/images/dentalImplantSide.jpg, https://example.com/images/dentalImplantCloseup.jpg (array[string], optional) - Additional public image URLs.
        + brandName: SmileCare (string, optional)
        + googleProductCategoryId: 123 (string, required) - Google product taxonomy ID.
        + price (object, required)
            + amount: 1500.00 (string, required) - Decimal string.
            + currencyCode: USD (string, required) - ISO 4217 code.
        + salePrice (object, optional)
            + amount: 1200.00 (string, required)
            + currencyCode: USD (string, required)
        + productSku: DENTAL-IMPLANT-001 (string, optional) - Merchant SKU; if omitted, system may assign.
        + productTypes: Dental Services, Implants, Cosmetic Dentistry (array[string], optional) - Product categorization keywords.
        + productUrl: https://example.com/products/dental-implant (string, optional)
        + status: PUBLISH (string, required) - Accepted values: `PUBLISH`, `DRAFT`.

    + Body

            {
              "businessNumbers": [145308764185002,145308769721320],
              "title": "Dental Implant",
              "description": "The dental procedure for replacing missing teeth using implants.",
              "imageLink": "https://example.com/images/dental-implant-main.jpg",
              "additionalImageLinks": [
                "https://example.com/images/dental-implant-side.jpg",
                "https://example.com/images/dental-implant-closeup.jpg"
              ],
              "brandName": "SmileCare",
              "googleProductCategoryId": "123",
              "price": { "amount": "1500.00", "currencyCode": "USD" },
              "salePrice": { "amount": "1200.00", "currencyCode": "USD" },
              "productSku": "DENTAL-IMPLANT-001",
              "productTypes": ["Dental Services", "Implants", "Cosmetic Dentistry"],
              "productUrl": "https://example.com/products/dental-implant",
              "status": "PUBLISH"
            }

+ Response 200 (application/json)

    + Attributes
        + productId: 68767cb39ebf51000815ab39 (string) - Unique identifier for the product.
        + code: `2565` (number, optional) - Error code. Present on validation failure.
        + message: `Product request validation failure` (string, optional) - Error message. Present on validation failure.
        + data (object, optional)
            + errorAttributes (array[object], optional)
                + type: `title` (string) - Type of validation error.
                + message: `Product name is missing in the request` (string) - Validation error message.

    + Body

            // Success response
            {
              "productId": "68767cb39ebf51000815ab39"
            }
            // Error response
            {
              "code": 2565,
              "message": "Product request validation failure",
              "data": {
                "errorAttributes": [
                  {
                    "type": "title",
                    "message": "Product name is missing in the request"
                  }
                ]
              }
            }

+ Response 401

    [1161][]

+ Response 429

    [89][]

+ Response 404

    [1011][]

+ Response 401

    [1167][]

## Update Product Listing [/v1/listing/public/product/{productId}]
Operations related to update a product listing.

### Update Product Listing [PUT]

+ Parameters

    + productId: 68767cb39ebf51000815ab39 (string, required) - Unique identifier of the product to update.

+ Request (application/json)

    + Headers

            Accept: application/json
            x-api-key: [Required] Partner specific API key provided by Birdeye for data exchange.
            x-business-number: [Required] User assosiated businessNumber

    + Attributes

        + businessNumbers: 145308764185002,145308769721320 (array) - Location numbers of enterprise locations. If empty all valid enterprise locations will be selected.
        + title: Dental Implant (string, required) - Product title.
        + description: The dental procedure for replacing missing teeth using implants. (string, optional)
        + imageLink: https://example.com/images/dentalImplantMain.jpg (string, required) - Publicly accessible image URL.
        + additionalImageLinks: https://example.com/images/dentalImplantSide.jpg, https://example.com/images/dentalImplantCloseup.jpg (array[string], optional) - Additional public image URLs.
        + brandName: SmileCare (string, optional)
        + googleProductCategoryId: 123 (string, required) - Google product taxonomy ID.
        + price (object, required)
            + amount: 1500.00 (string, required) - Decimal string.
            + currencyCode: USD (string, required) - ISO 4217 code.
        + salePrice (object, optional)
            + amount: 1200.00 (string, required)
            + currencyCode: USD (string, required)
        + productTypes: Dental Services, Implants, Cosmetic Dentistry (array[string], optional) - Product categorization keywords.
        + productUrl: https://example.com/products/dental-implant (string, optional)
        + status: PUBLISH (string, required) - Accepted values: `PUBLISH`, `DRAFT`.

    + Body

            {
              "businessNumbers": [145308764185002,145308769721320],
              "title": "Dental Implant",
              "description": "The dental procedure for replacing missing teeth using implants.",
              "imageLink": "https://example.com/images/dental-implant-main.jpg",
              "additionalImageLinks": [
                "https://example.com/images/dental-implant-side.jpg",
                "https://example.com/images/dental-implant-closeup.jpg"
              ],
              "brandName": "SmileCare",
              "googleProductCategoryId": "123",
              "price": { "amount": "1500.00", "currencyCode": "USD" },
              "salePrice": { "amount": "1200.00", "currencyCode": "USD" },
              "productTypes": ["Dental Services", "Implants", "Cosmetic Dentistry"],
              "productUrl": "https://example.com/products/dental-implant",
              "status": "PUBLISH"
            }

+ Response 200 (application/json)

    + Attributes
        + productId: 68767cb39ebf51000815ab39 (string) - Unique identifier for the product.
        + code: `2565` (number, optional) - Error code. Present on validation failure.
        + message: `Product request validation failure` (string, optional) - Error message. Present on validation failure.
        + data (object, optional)
            + errorAttributes (array[object], optional)
                + type: `title` (string) - Type of validation error.
                + message: `Product name is missing in the request` (string) - Validation error message.

    + Body

            // Error response
            {
              "code": 2565,
              "message": "Product request validation failure",
              "data": {
                "errorAttributes": [
                  {
                    "type": "title",
                    "message": "Product name is missing in the request"
                  }
                ]
              }
            }

+ Response 401

    [1161][]

+ Response 429

    [89][]

+ Response 404

    [1011][]

+ Response 401

    [1167][]


## Get Product Listing [/v1/listing/public/product/{productIdentifier}]
Operations related to get a product listing.

### Get Product Listing [GET]

+ Parameters

    + productIdentifier: 68767cb39ebf51000815ab39 (string, required) - Product identifier.

+ Request (application/json)

    + Headers

            Accept: application/json
            x-api-key: [Required] Partner specific API key provided by Birdeye for data exchange.
            x-business-number: [Required] User assosiated businessNumber

+ Response 200 (application/json)

    + Attributes
        + productId: 68a700bc022db880b5ffa038 (string)
        + productSku: 7654749435-3 (string)
        + locationCount: 1 (number)
        + title: Family Dental Plan (string)
        + description: Use this product to purchase the family dental plan for 3 visits/year for a family of 4 (string)
        + productUrl: https://dentist-bragadiru.ro/preturi/ (string)
        + imageLink: https://shopping.googleusercontent.com/image?... (string)
        + additionalImageLinks: ... (array[string])
        + videoUrl: Family Dental Plan  (string)
        + brandName: SDR Clinic (string)
        + googleProductCategoryId: 5010 (string)
        + price (object)
            + amount: 35 (string)
            + currencyCode: USD (string)
        + productTypes: FamilyDentalHelath (array[string])
        + salePrice (object)
            + amount: 35 (string)
            + currencyCode: USD (string)
        + status: DRAFT (string)
        + updatedOn: Mar 05 (string) - Display value or timestamp depending on environment.
        + updatedBy: XYZ (string)
        + code: `2561` (number, optional) - Error code. Present on validation failure.
        + message: `Products are not found with given criteria` (string, optional) - Error message. Present on validation failure.

    + Body

            // Success response
            {
              "productId": "68a700bc022db880b5ffa038",
              "productSku": "7654749435-3",
              "locationCount": 1,
              "title": "Family Dental Plan",
              "description": "Use this product to purchase the family dental plan for 3 visits/year for a family of 4",
              "productUrl": "https://dentist-bragadiru.ro/preturi/",
              "imageLink": "https://shopping.googleusercontent.com/image?q=AJqGhtVeXk2QAlVze5sxdIkrJqvnVzU_ApEvuPtiqXtE5slPUnd8ev_mctvrSvvwkcw6EYPn-6JoCfGyi1yp",
              "additionalImageLinks": [
                "https://shopping.googleusercontent.com/image?q=AJqGhtWrkvUc_hlewjdruW0_pE94O2KroiTvT9Iyvoq8rEo31Tdn0v4FYhxTsUbt2I-lu2Y2-8JVBA8P2flC"
              ],
              "videoUrl": "",
              "brandName": "SDR Clinic",
              "googleProductCategoryId": "5010",
              "price": { "amount": "35", "currencyCode": "USD" },
              "productTypes": ["FamilyDentalHelath"],
              "salePrice": { "amount": "35", "currencyCode": "USD" },
              "status": "DRAFT",
              "updatedOn": "Mar 05",
              "updatedBy": "XYZ"
            }
            // Error response
            {
              "code": 2561,
              "message": "Products are not found with given criteria"
            }

+ Response 401

    [1161][]

+ Response 429

    [89][]

+ Response 404

    [1011][]

+ Response 401

    [1167][]

## Delete Product Listings  [/v1/listing/public/product/deleteProduct]
Deletes products from Google Merchant Center and Birdeye for the provided product IDs.

### Delete Product Listings  [POST]

+ Request (application/json)

    + Headers

            Accept: application/json
            x-api-key: [Required] Partner specific API key provided by Birdeye for data exchange.
            x-business-number: [Required] User assosiated businessNumber

    + Attributes
        + productIds: 68767cb39ebf51000815ab39,68767cb39ebf51000815ab39 (array[string], required) - IDs to delete.

    + Body

            {
              "productIds": [
                "68767cb39ebf51000815ab39",
                "68767cb39ebf51000815ab39"
              ]
            }

+ Response 200 (application/json)

    + Attributes
        + code: `2561` (number, optional) - Error code. Present on validation failure.
        + message: `Products are not found with given criteria` (string, optional) - Error message. Present on validation failure.

    + Body

            // Error response
            {
              "code": 2561,
              "message": "Products are not found with given criteria"
            }

+ Response 401

    [1161][]

+ Response 429

    [89][]

+ Response 404

    [1011][]

+ Response 401

    [1167][]


## Get List Product Listing [/v1/listing/public/product/getList{?pageSize,pageNumber}]
Returns paginated product listings for the account/locations based on search and filters.

### Get List Product Listing [POST]

+ Parameters

    + pageSize: 50 (number, optional) - Number of records per page. Default 50.
    + pageNumber: 0 (number, optional) - 0-based page index. Default 0.

+ Request (application/json)

    + Headers

            Accept: application/json
            x-api-key: [Required] Partner specific API key provided by Birdeye for data exchange.
            x-business-number: [Required] User assosiated businessNumber

    + Attributes
        + search: Dental (string, optional) - Regex/contains on title.
        + status: DRAFT,PUBLISH (array[string], optional) - Filter by status.
        + businessNumbers: 145308764185002,145308769721320 (array, optional) - Location numbers of enterprise locations. If empty all valid enterprise locations will be selected.

    + Body

            {
              "search": "Dental",
              "status": ["DRAFT","PUBLISH"],
              "businessNumbers": []
            }

+ Response 200 (application/json)

    + Attributes
        + response (array[object]) - Product list
            + (object)
                + productId: 689af8f4f198dfbdfc88f05c (string)
                + productSku: 7654749435 (string)
                + locationCount: 2 (number)
                + title: Family Dental Plan (string)
                + description: Use this product to purchase the family dental plan for 3 visits/year for a family of 4 (string)
                + productUrl: https://dentist-bragadiru.ro/preturi/ (string)
                + imageLink: https://shopping.googleusercontent.com/image?... (string)
                + additionalImageLinks: ... (array[string])
                + videoUrl: Family Dental Plan  (string)
                + brandName: SDR Clinic (string)
                + googleProductCategoryId: 5823 (string)
                + price (object)
                    + amount: 3500000000 (string)
                    + currencyCode: INR (string)
                + productTypes: FamilyDentalHelath (array[string])
                + salePrice (object)
                    + amount: 2500000000 (string)
                    + currencyCode: INR (string)
                + status: PUBLISH (string)
                + updatedOn: 1754993514625 (number) - Epoch time.
                + updatedBy: XYZ (string)
        + totalCount: 100 (number)

    + Body

            {
              "response": [
                {
                  "productId": "689af8f4f198dfbdfc88f05c",
                  "productSku": "7654749435",
                  "locationCount": 2,
                  "title": "Family Dental Plan",
                  "description": "Use this product to purchase the family dental plan for 3 visits/year for a family of 4",
                  "productUrl": "https://dentist-bragadiru.ro/preturi/",
                  "imageLink": "https://shopping.googleusercontent.com/image?q=AJqGhtVeXk2QAlVze5sxdIkrJqvnVzU_ApEvuPtiqXtE5slPUnd8ev_mctvrSvvwkcw6EYPn-6JoCfGyi1yp",
                  "additionalImageLinks": [
                    "https://shopping.googleusercontent.com/image?q=AJqGhtWrkvUc_hlewjdruW0_pE94O2KroiTvT9Iyvoq8rEo31Tdn0v4FYhxTsUbt2I-lu2Y2-8JVBA8P2flC"
                  ],
                  "videoUrl": "",
                  "brandName": "SDR Clinic",
                  "googleProductCategoryId": "5823",
                  "price": { "amount": "3500000000", "currencyCode": "INR" },
                  "productTypes": ["FamilyDentalHelath"],
                  "salePrice": { "amount": "2500000000", "currencyCode": "INR" },
                  "status": "PUBLISH",
                  "updatedOn": 1754993514625,
                  "updatedBy": "XYZ"
                }
              ],
              "totalCount": 100
            }

+ Response 401

    [1161][]

+ Response 429

    [89][]

+ Response 404

    [1011][]

+ Response 401

    [1167][]


## Add Products On a Location [/v1/listing/public/product/addProduct]
Adds products (by IDs) to the Google profile of the business provided in headers.

### Add Products On a Location [POST]

+ Request (application/json)

    + Headers

            Accept: application/json
            x-api-key: [Required] Partner specific API key provided by Birdeye for data exchange.
            x-business-number: [Required] User assosiated businessNumber

    + Attributes
        + productIds: 68767cb39ebf51000815ab39,68767cb39ebf51000815ab39 (array[string], required)

    + Body

            {
              "productIds": [
                "68767cb39ebf51000815ab39",
                "68767cb39ebf51000815ab39"
              ]
            }

+ Response 200 (application/json)

    + Attributes
        + code: 2564 (number)
        + message: String (string)

    + Body

            {
              "code": 2564,
              "message": "Product not or Partial found with given productId List"
            }

+ Response 401

    [1161][]

+ Response 429

    [89][]

+ Response 404

    [1011][]

+ Response 401

    [1167][]

## Remove Products On a Location [/v1/listing/public/product/removeProduct]
Removes products (by IDs) to the Google profile of the business provided in headers.

### Remove Products On a Location [POST]

+ Request (application/json)

    + Headers

            Accept: application/json
            x-api-key: [Required] Partner specific API key provided by Birdeye for data exchange.
            x-business-number: [Required] User assosiated businessNumber

    + Attributes
        + productIds: 68767cb39ebf51000815ab39,68767cb39ebf51000815ab39 (array[string], required)

    + Body

            {
              "productIds": [
                "68767cb39ebf51000815ab39",
                "68767cb39ebf51000815ab39"
              ]
            }

+ Response 200 (application/json)

    + Attributes
        + code: 2564 (number)
        + message: String (string)

    + Body

            {
              "code": 2564,
              "message": "Product not or Partial found with given productId List"
            }

+ Response 401

    [1161][]

+ Response 429

    [89][]

+ Response 404

    [1011][]

+ Response 401

    [1167][]



# Group Ticketing
Create standout customer support with ticketing across reviews, untagged, and survey responses.

## Create ticket [/v1/ticket/{businessNumber}/create-ticket]
Create reviews, untagged, and survey responses tickets.

### Create ticket [PUT]

+ Parameters

    + businessNumber: 169744180007807 (number, required) - Business number of the location on which we want to create a ticket.


+ Request (application/json)

    + Headers

            Accept: application/json
            x-api-key: 2uiHKCTi8hSg35MG75aaot0B2SAokhjk (string, required) - Partner specific API key provided by Birdeye for data exchange.

    + Attributes
        + externalId: 3943351204239963055 (number) - Public Review Id for which you want to create ticket, Mandatory and applicable for creating review ticket.
        + assignedTo: warne@ymail.com (required, string) - EmailId of the user to whom the ticket will be assigned.
        + ticketType: review (required, string) - Type of ticket you want to create. Possible values:
                                                review,
                                                untagged,
                                                SURVEY
        + customer (object) -Customer details for which ticket is created, Mandatory and applicable for untagged ticket
            + emailId: steven@ymail.com (string) - Email id of the customer.
            + firstName: Steve (string) - First name of the customer.
            + lastName: Smith (string) - Last name of the customer.
            + location (object) - Location details of the customer.
                + city: Dallas (string) - City of the customer’s location.
                + state: Texas (string) - State of the customer’s location.
            + phone: 4032365164 (number)- Phone number of the customer.
        + description: Issue with the Store service (string) - Description of the ticket. Applicable for untagged and survey ticket
        + sourceType: Email (string) - Source Type of the ticket. Applicable for untagged ticket Possible values:
                                        Email,
                                        Phone,
                                        Chat,
                                        Internal,
                                        Social media
        + surveyId: 43503 (number) - Id of the survey for which we want to create a ticket. Applicable for survey ticket
        + surveyResponseId: 13577112 (number) - Id of the survey response for which we want to create a ticket. Applicable for survey ticket
        + additionalParams (array) - If you want to create tickets of survey for particular question and answer. Applicable for survey ticket
            + answerId: 1024530591 (number) - Id of any of the answers on the survey. Applicable for survey ticket
            + questionId: 221132 (number) - Id of any of the questions on the survey. Applicable for survey ticket






    + Body

            {
                "externalId": 3943351204239963055,
                "assignedTo": "pranav.singh@birdeye.com",
                "ticketType":"review",
                "customer": {
                    "emailId": "test+4@yopmail.com",
                    "firstName": "Steve",
                    "lastName": "Smith",
                    "location": {
                        "city": "Dallas",
                        "state": "Texas"
                    },
                    "phone": ""
                },
                "description": "Issue with the Store service",
                "sourceType": "internal"
            }



+ Response 200

    + Attributes
        + ticketId: 882382 (number) - Id of the new ticket created.



    + Body

            {
                "ticketId": 882382
            }


+ Response 401

    [1161][]

+ Response 401

    [1167][]

+ Response 429

    [89][]

+ Response 401

    [1033][]

+ Response 404

    [1175][]




## Add Ticket Comments [/v1/ticket/{businessNumber}/comment-activity]
Add comment activity on tickets.

### Add Ticket Comments [POST]

+ Parameters

    + businessNumber: 169744180007807 (number, required) - Business number of the location.


+ Request (application/json)

    + Headers

            Accept: application/json
            x-api-key: 2uiHKCTi8hSg35MG75aaot0B2SAokhjk (string, required) - Partner specific API key provided by Birdeye for data exchange.

    + Attributes
        + comment: Had a chat with customer, he will visit again. (required, string) - Comment to be added on ticket.
        + ticketId: 886172 (required, number) - Id of the ticket.
        + userEmail: steve@ymail.com (required,string) - EmailId of the user who is adding the comment.



    + Body

            {
                "comment": "Had a chat with customer, he will visit again.",
                "ticketId": "886172",
                "userEmail": "steve@ymail.com"
            }



+ Response 200

    + Attributes
        + ticketId: 882382 (number) - Id of the new ticket created.



    + Body

            {
                "ticketId": 882382
            }


+ Response 401

    [1161][]

+ Response 401

    [1167][]

+ Response 429

    [89][]

+ Response 401

    [1033][]

+ Response 404

    [1175][]




## Update ticket [/v1/ticket/{businessNumber}/update]
Update the ticket status or ticket assignee.


### Update ticket [PUT]

+ Parameters

    + businessNumber: 169744180007807 (number, required) - Business number of the location.


+ Request (application/json)

    + Headers

            Accept: application/json
            x-api-key: 2uiHKCTi8hSg35MG75aaot0B2SAokhjk (string, required) - Partner specific API key provided by Birdeye for data exchange.

    + Attributes
        + ticketUpdateMessages (array) - Update ticket.
            + (object)
                + assignedTo: steve@ymail.com (string) - New assignee of the ticket.
                + ticketId: 882382 (string) - Id of the ticket.
                + ticketStatus: assigned (string) - Status to be changed.


    + Body

            {
                "ticketUpdateMessages": [{
                    "assignedTo": "steve@ymail.com",
                    "ticketId": "882382",
                    "ticketStatus": "assigned"
                }],
                "userEmail": "pranav.singh@birdeye.com"
            }



+ Response 200

+ Response 401

    [1161][]

+ Response 401

    [1167][]

+ Response 429

    [89][]

+ Response 401

    [1033][]

+ Response 404

    [1175][]




## Get All Ticket Data [/v1/ticket/{businessNumber}/get/all?{?op,sortOrder,count,sIndex,sortBy,totalCount}]
Get tickets

### Get All Ticket Data [POST]

+ Parameters

    + businessNumber: 169744180007807 (number, required) - Business number of the account.
    + op: 3 (number) - Possible values are: [1] will display ticket count only, [3] will display all the data of the ticket. Default value - 3.
    + sIndex: 0 (number) - Start index of the response. Default value - 0
    + count: 25  (number) - Number of tickets want to get in the response. Default value - 25
    + sortBy: 2  (number) - Sort options, Possible values [2] will sort on the basis of ticket creation date. [3] will sort on the basis of characters of business aliases. Default value 2.
    + sortOrder: 1 (number) - Sort Order [0] will sort the data in ascending order. [1] this will sort the data in descending order. Default value - 1
    + totalCount: true (Boolean) false, total count would not be displayed. true, total count would be displayed along with the data of all the tickets. Default Value - false



+ Request (application/json)

    + Headers

            Accept: application/json
            x-api-key: 2uiHKCTi8hSg35MG75aaot0B2SAokhjk (string, required) - Partner specific API key provided by Birdeye for data exchange.

    + Attributes
        + assignees: steve@ymail.com,smith@ymail.com (array) - List of assignee email id.
        + businessNumbers: 123123123,12314231 (array) - List of Location Business Numbers.
        + fromDate: 1581230064000 (number) - Epoc start date.
        + toDate: 1707460464000 (number) - Epoc end date.
        + sourceAliases: google (array) - Source alias.
        + sourceTypes: phone (array) - Source Type.
        + tagNames: newReview (array) - Tag assigned to any review ticket.
        + ticketStatuses: new (array) - Filter tickets with status.
        + ticketTypes: review,survey (array) - List of ticket type, Possible values
                                                review,
                                                untagged,
                                                survey


    + Body

            {
                "assignees": [],
                "businessNumbers": [],
                "fromDate": 1581230064000,
                "sourceAliases": [""],
                "sourceTypes": ["phone","socialmedia","chat","internal"],
                "tagNames": ["newReview"],
                "ticketStatuses": ["assigned", "new"],
                "ticketTypes": ["review", "survey", "untagged"],
                "toDate": 1707460464000
            }



+ Response 200

    + Attributes
        + ticketDetails (array) - Ticket Details.
            + (object)
                + id: 188556 (number) - Id of the ticket.
                + status: new (string) - Ticket status.
                + rating: 5.0 (number) - Review rating.
                + externalId: 213243231 (string) - Public review id.
                + description: Customer will visit again (string) - Description of the ticket.
                + activityCount: 4 (number) - Number of activities associated with the ticket.
                + assignedTo (object) - Assignee details.
                    + firstName: Steve (string) - First Name of the assignee.
                    + lastName: Steve (string) - Last Name of the assignee.
                    + name: Steve Smith (string) - Name  of the assignee.
                    + emailId: steve@ymail.com (string) - Email id of the assignee.
                + source (object) - Source details of the ticket
                    + name: Google (string)- Source details
                                                        [1] “Google”, in case of a review ticket.
                                                        [2] “email”, in case of an untagged ticket.
                                                        [3] “Training Feb 24th”, name of the survey in case of survey ticket.
                + ticketType: review (string) - Type of the ticket.
                + tags: newreview (array) - List of Ticket tags.
                + reporter (object) - Ticket reporter details.
                    + firstName: Steve (string) - First Name of the reporter
                    + lastName: Smith (string) -  Last Name of the reporter




    + Body

            {
                "ticketDetails": [{
                    "id": 188556,
                    "status": "assigned",
                    "rating": 5.0,
                    "externalId": 2131605005145285326,
                    "date": "2020-02-14 00:08:00",
                    "postedOn": "2020-02-08 00:00:00",
                    "updateDate": "2020-08-11 00:00:00",
                    "created": "2020-02-14 12:08:02",
                    "description": "Room was outstanding....location was also good....",
                    "activityCount": 4,
                    "assignedTo": {
                        "firstName": "Atul",
                        "lastName": "Ghainna",
                        "emailId": "atulkumar.ghainna@birdeye.com",
                        "name": "Atul Ghainna"
                    },
                    "business": {
                        "name": "JYSK - Whitby",
                        "alias": "JYSK - Whitby",
                        "number": 157851547625021,
                        "phone": "(905) 451-9054"
                    },
                    "source": {
                        "name": "Airbnb"
                    },
                    "ticketType": "review",
                    "tags": [
                        "awesome",
                        "it was good",
                        "newtest",
                        "promoters!!!",
                        "great service",
                        "time",
                        "poor",
                        "Enjoy",
                        "newtag",
                        "test",
                        "check",
                        "good review",
                        "excellent",
                        "Dirty Car",
                        "User request no response",
                        "customer service",
                        "nice"
                    ],
                    "reporter": {
                        "firstName": "Megha",
                        "lastName": ""
                    }
                },
                {
                    "id": 192727,
                    "status": "assigned",
                    "date": "2020-02-18 00:34:00",
                    "updateDate": "2020-02-18 00:00:00",
                    "created": "2020-02-18 12:34:18",
                    "description": "Apil look into it.",
                    "activityCount": 2,
                    "assignedTo": {
                        "firstName": "April",
                        "lastName": "Dover",
                        "emailId": "aparna.dass@birdeye.com",
                        "name": "April Dover"
                    },
                    "business": {
                        "name": "JYSK - Cambridge",
                        "alias": "JYSK - Cambridge",
                        "number": 157721146574913,
                        "phone": "(905) 451-9054"
                    },
                    "source": {
                        "name": "phone"
                    },
                    "ticketType": "untagged",
                    "reporter": {
                        "firstName": "Jerry",
                        "lastName": "Jacob",
                        "emailId": "jerry@jerry.com",
                        "phone": ""
                    }
                },
                {
                    "id": 199287,
                    "status": "assigned",
                    "date": "2020-02-27 01:28:00",
                    "postedOn": "2020-02-27 00:00:00",
                    "updateDate": "2020-10-29 00:00:00",
                    "created": "2020-02-27 01:28:14",
                    "description": "Question: Please rate us based on your training experience\nAnswer: 1",
                    "activityCount": 3,
                    "assignedTo": {
                        "firstName": "April",
                        "lastName": "Dover",
                        "emailId": "aparna.dass@birdeye.com",
                        "name": "April Dover"
                    },
                    "business": {
                        "name": "JYSK - Whitby",
                        "alias": "JYSK - Whitby",
                        "number": 157851547625021,
                        "phone": "(905) 451-9054"
                    },
                    "source": {
                        "name": "Training Feb 24th"
                    },
                    "ticketType": "survey",
                    "surveyId": 15492
                }
            ],
            "count": 0,
            "totalcount": 3
        }



+ Response 401

    [1161][]

+ Response 401

    [1167][]

+ Response 429

    [89][]

+ Response 401

    [1033][]

+ Response 404

    [1175][]




# Group Integration
Birdeye integrates with various software or tools you use.

## Add Business Integration Mapping [/v1/integrations/add/businessintegrationmapping]
Add Business Integration Mapping adds locations to integrations and set them active.

### Add locations [PUT]


+ Request (application/json)

    + Headers

            Accept: application/json
            x-api-key: [Required] Partner specific API key provided by Birdeye for data exchange.

    + Attributes
        + businessNumber: 169744180007807 (required, number) - Business number.
        + integrationGroupId: 12345 (required, number) - Integration Group Id.
        + active: true (required, boolean) - Active state.
        + integrationProperties (object) - Add properties in key value pair.


    + Body

            {
                "businessNumber": 166015909542313,
                "integrationGroupId": 12345,
                "active": true,
                "integrationProperties": [
                    {
                        "propertyKey": "property_key",
                        "propertyValue": "1234567"
                    }
                  ]
            }

+ Response 200

+ Response 401

    [1161][]

+ Response 401

    [1167][]

+ Response 429

    [89][]

+ Response 401

    [1033][]

+ Response 404

    [1175][]

+ Response 400

    [1422][]



# Group Change Logs

* <b>03/18/2026</b> - Added Create Custom Card Time API under custom fields section.
* <b>03/03/2026</b> - Added Response Time (overtime & by-location) and Response Rate(overtime & by-location) APIs under reports section and created group for Competitor AI.
* <b>03/02/2026</b> - Added sendInvite (boolean, default - true) field in Create User Signup v2 API request body and attributes.
* <b>02/11/2026</b> - Updated the API key identifier for applicable APIs by moving it from a query parameter to the x-api-key request header.
* <b>02/03/2026</b> - Added the "Get All QnA" API under FAQ group to enable retrieval of QnA entries across business locations, with full request and response documentation
* <b>01/19/2026</b> - Added a note under the Authentication and Rate limiting section specifying that the x-api-key header is mandatory for all API requests targeting EU region business accounts.
* <b>01/13/2026</b> - Added Create User (Signup) API under User module to create and invite users for a business.
* <b>09/22/2025</b> - Added GMB Products APIs to onboard/connect Google Merchant accounts and manage product listing actions.
* <b>08/21/2025</b> - Added Single main business description Support.
* <b>08/19/2025</b> - Added competitor /raptor public APIs for reviews aggregates.
* <b>06/26/2025</b> - Added Contact V2 APIs with communication preference flag support.
* <b>12/13/2024</b> - Added inline reply support for GetReviews APIs.
* <b>09/27/2024</b> - Added update for Google Opening Soon (BIRD-56987)
* <b>06/25/2024</b> - Updated Listings Insights API (BIRDEYE-137367)
* <b>05/29/2024</b> - Added Google Q&A Developers API Section
* <b>05/13/2024</b> - Added epoc date support for GetReviews APIs.
* <b>03/22/2024</b> - Add Update Hierarchy API (BIRD-32609)
* <b>03/19/2024</b> - Added Ticket APIs Create, Get, Update APIs under Ticket module
* <b>02/26/2024</b> - Updated logoUrl description in Get, Update APIs under Business module and Create, Get, Update APIs under Listing module (BIRD-29386)
* <b>12/21/2023</b> - Add listing phase 2 api changes (BIRD-16589)
* <b>11/08/2023</b> - Add survey changes (BIRD-11944) and listing changes (BIRD-14345)
* <b>11/08/2023</b> - Added CRUD APIs for Apple chat
* <b>10/15/2023</b> - Added CRUD APIs for Business Media.
* <b>10/11/2023</b> - Added new APIs under Listing module, Create, Update, Get, Deactive Listings
* <b>09/18/2023</b> - Added new API under Contact module i.e, Get opt-out contact data
* <b>08/25/2023</b> - Added new APIs under Business and Listing modules, Get Category List API, Get GMB Attributes API & Get Timezone List
* <b>07/21/2023</b> - Added new API under Business module i.e, Business Search API.
* <b>06/30/2023</b> - Added support for service area based information in Get Business API and Update Business API.
* <b>10/04/2024</b> - Added support to fetch ticketId associated with the survey responses in List Response API.