From 3efb131f3948080d353f3a42db763188bd97106d Mon Sep 17 00:00:00 2001 From: Harshita Rastogi Date: Tue, 17 Feb 2026 15:25:11 +0530 Subject: [PATCH 1/6] fix commit --- apiary.apib | 596 ++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 596 insertions(+) diff --git a/apiary.apib b/apiary.apib index 43fc25e..1a7bb19 100644 --- a/apiary.apib +++ b/apiary.apib @@ -2038,6 +2038,105 @@ For example : "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) @@ -14253,6 +14352,503 @@ Get all Unanswered Questions and Answers for a Location [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{?api_key,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{?api_key,businessId}] + ++ Parameters + + businessId: 169744180007807 (number, required) - Id of the account + + api_key: 2uiHKCTi8hSg35MG75aaot0B2SAokhjk (string, required) - Partner specific API key provided by Birdeye for data exchange. + ++ Request (application/json) + + + Attributes + + name: Customer Service (string, required) - Service name (1–140 characters) + + priceType: paid (string, required) - 'paid' or 'free' + + currencyCode: USD (string, optional) - Required if priceType is 'paid' + + price: 100.50 (number, optional) - Required if priceType is 'paid' + + description: We provide 24x7 customer service (string, optional) - Max 300 characters + + + Body + + { + "name": "Customer Service", + "priceType": "paid", + "currencyCode": "USD", + "price": 100.50, + "description": "We provide 24x7 customer service" + } + ++ 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{?api_key,businessId,startIndex,pageSize,sortBy,sortOrder}] +Get all services for an account + +### Get All Services [POST] + ++ Parameters + + + businessId: 169744180007807 (number, required) - Id of the account + + api_key: 2uiHKCTi8hSg35MG75aaot0B2SAokhjk (string, required) - Partner specific API key provided by Birdeye for data exchange. + + 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 + + + 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 + + priceType: paid (string) - price type 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 + + + Body + + { + "services": [ + { + "serviceId": "SERV10021056", + "name": "Customer Service", + "priceType": "paid", + "currencyCode": "USD", + "price": 100.50, + "description": "We provide 24x7 customer service" + } + ] + } + ++ Response 401 + + [1161][] + ++ Response 429 + + [89][] + ++ Response 404 + + [1011][] + ++ Response 401 + + [1167][] + ++ Response 400 + + [2486][] + + + +## Update Service [/v1/google-services/service/update{?api_key,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 + + api_key: 2uiHKCTi8hSg35MG75aaot0B2SAokhjk (string, required) - Partner specific API key provided by Birdeye for data exchange. + + ++ Request (application/json) + + + Headers + + Accept: application/json + + + 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. + + priceType: paid (string , required) - text of the service price type to be posted on Google Services profile ; 'paid' or 'free' value + + 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 + + + + Body + + { + "serviceId": "SERV10021056", + "name": "Customer Service", + "priceType": "paid", + "currencyCode": "USD", + "price": 100.50, + "description": "We provide 24x7 customer service" + } + + ++ 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{?api_key,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 + + api_key: 2uiHKCTi8hSg35MG75aaot0B2SAokhjk (string, required) - Partner specific API key provided by Birdeye for data exchange. + ++ Request (application/json) + + + Headers + + Accept: application/json + + + 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{?api_key,businessId}] +Get location level service - category mapping + +### Get Location Mapping [GET] + ++ Parameters + + + businessId: 169744180007807 (number, required) - Id of the business + + api_key: 2uiHKCTi8hSg35MG75aaot0B2SAokhjk (string, required) - Partner specific API key provided by Birdeye for data exchange. + + ++ Request (application/json) + + + Headers + + Accept: application/json + + ++ 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 + + priceType: paid (string) - price type 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 + + + Body + + { + "Marketing" : [ + { + "serviceId": "SERV10021056", + "name": "Customer Service", + "priceType": "paid", + "currencyCode": "USD", + "price": 100.50, + "description": "We provide 24x7 customer service" + }, + { + "serviceId": "SERV10021057", + "name": "Marketing Service", + "priceType": "free", + "description": "We provide 24x7 marketing service" + } + ], + "Advertisement" : [ + { + "serviceId": "SERV10021058", + "name": "Advertising Service", + "priceType": "paid", + "currencyCode": "USD", + "price": 100.50, + "description": "We provide advertising service across various platforms" + } + ] + } + ++ Response 401 + + [1161][] + ++ Response 429 + + [89][] + ++ Response 404 + + [1011][] + ++ Response 401 + + [1167][] + ++ Response 400 + + [2486][] + + +## Update Location Mapping [/v1/google-services/services/location-mapping{?api_key,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 + + api_key: 2uiHKCTi8hSg35MG75aaot0B2SAokhjk (string, required) - Partner specific API key provided by Birdeye for data exchange. + + ++ Request (application/json) + + + Headers + + Accept: application/json + + + 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. From 43d0d32eea7abf2e4d156cb53aeae7bdb66bbe02 Mon Sep 17 00:00:00 2001 From: "vitthal.chandankar" Date: Wed, 18 Feb 2026 11:26:09 +0530 Subject: [PATCH 2/6] BIRD-183208: google services public api change for group and duration fields --- apiary.apib | 46 ++++++++++++++++++++++++++++++++-------------- 1 file changed, 32 insertions(+), 14 deletions(-) diff --git a/apiary.apib b/apiary.apib index 1a7bb19..ac194cb 100644 --- a/apiary.apib +++ b/apiary.apib @@ -14360,17 +14360,17 @@ Get all Unanswered Questions and Answers for a Location > - _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{?api_key,businessId}] +## Create Service [/v1/google-services/service/create{?api_key,accountId}] 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{?api_key,businessId}] +### Create Service [POST /v1/google-services/service/create{?api_key,accountId}] + Parameters - + businessId: 169744180007807 (number, required) - Id of the account + + accountId: 169744180007807 (number, required) - Id of the account + api_key: 2uiHKCTi8hSg35MG75aaot0B2SAokhjk (string, required) - Partner specific API key provided by Birdeye for data exchange. + Request (application/json) @@ -14381,6 +14381,8 @@ Create a new service for the account + currencyCode: USD (string, optional) - Required if priceType is 'paid' + price: 100.50 (number, optional) - Required if priceType is 'paid' + 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 @@ -14389,7 +14391,9 @@ Create a new service for the account "priceType": "paid", "currencyCode": "USD", "price": 100.50, - "description": "We provide 24x7 customer service" + "description": "We provide 24x7 customer service", + "group": "Hair Care", + "duration": 90 } + Response 200 (application/json) @@ -14454,14 +14458,14 @@ Create a new service for the account -## Get All Services [/v1/google-services/services{?api_key,businessId,startIndex,pageSize,sortBy,sortOrder}] +## Get All Services [/v1/google-services/services{?api_key,accountId,startIndex,pageSize,sortBy,sortOrder}] Get all services for an account ### Get All Services [POST] + Parameters - + businessId: 169744180007807 (number, required) - Id of the account + + accountId: 169744180007807 (number, required) - Id of the account + api_key: 2uiHKCTi8hSg35MG75aaot0B2SAokhjk (string, required) - Partner specific API key provided by Birdeye for data exchange. + startIndex: 0 (number) - start index; default 0 + pageSize: 25 (number) - page size; default 25 @@ -14498,6 +14502,8 @@ Get all services for an account + 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 @@ -14509,7 +14515,9 @@ Get all services for an account "priceType": "paid", "currencyCode": "USD", "price": 100.50, - "description": "We provide 24x7 customer service" + "description": "We provide 24x7 customer service", + "group": "Hair Care", + "duration": 90 } ] } @@ -14536,7 +14544,7 @@ Get all services for an account -## Update Service [/v1/google-services/service/update{?api_key,businessId}] +## Update Service [/v1/google-services/service/update{?api_key,accountId}] Update an existing service of an account. > __Note__ @@ -14546,7 +14554,7 @@ Update an existing service of an account. + Parameters - + businessId: 169744180007807 (number, required) - Id of the account + + accountId: 169744180007807 (number, required) - Id of the account + api_key: 2uiHKCTi8hSg35MG75aaot0B2SAokhjk (string, required) - Partner specific API key provided by Birdeye for data exchange. @@ -14564,6 +14572,8 @@ Update an existing service of an account. + 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 @@ -14574,7 +14584,9 @@ Update an existing service of an account. "priceType": "paid", "currencyCode": "USD", "price": 100.50, - "description": "We provide 24x7 customer service" + "description": "We provide 24x7 customer service", + "group": "Hair Care", + "duration": 90 } @@ -14633,7 +14645,7 @@ Update an existing service of an account. [2494][] -## Delete Services [/v1/google-services/service/delete{?api_key,businessId}] +## Delete Services [/v1/google-services/service/delete{?api_key,accountId}] Delete existing services of an account > __Note__ @@ -14643,7 +14655,7 @@ Delete existing services of an account + Parameters - + businessId: 169744180007807 (number, required) - Id of the account + + accountId: 169744180007807 (number, required) - Id of the account + api_key: 2uiHKCTi8hSg35MG75aaot0B2SAokhjk (string, required) - Partner specific API key provided by Birdeye for data exchange. + Request (application/json) @@ -14723,6 +14735,8 @@ Get location level service - category mapping + 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 @@ -14734,7 +14748,9 @@ Get location level service - category mapping "priceType": "paid", "currencyCode": "USD", "price": 100.50, - "description": "We provide 24x7 customer service" + "description": "We provide 24x7 customer service", + "group": "Hair Care", + "duration": 90 }, { "serviceId": "SERV10021057", @@ -14750,7 +14766,9 @@ Get location level service - category mapping "priceType": "paid", "currencyCode": "USD", "price": 100.50, - "description": "We provide advertising service across various platforms" + "description": "We provide advertising service across various platforms", + "group": "Hair Care", + "duration": 90 } ] } From f23643ed4c9a0d980c59fd84f6badfa697a85f99 Mon Sep 17 00:00:00 2001 From: "vitthal.chandankar" Date: Wed, 18 Feb 2026 12:18:43 +0530 Subject: [PATCH 3/6] BIRD-183208: price type field removal --- apiary.apib | 14 ++------------ 1 file changed, 2 insertions(+), 12 deletions(-) diff --git a/apiary.apib b/apiary.apib index ac194cb..fd7563d 100644 --- a/apiary.apib +++ b/apiary.apib @@ -14377,9 +14377,8 @@ Create a new service for the account + Attributes + name: Customer Service (string, required) - Service name (1–140 characters) - + priceType: paid (string, required) - 'paid' or 'free' - + currencyCode: USD (string, optional) - Required if priceType is 'paid' - + price: 100.50 (number, optional) - Required if priceType is 'paid' + + 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 @@ -14388,7 +14387,6 @@ Create a new service for the account { "name": "Customer Service", - "priceType": "paid", "currencyCode": "USD", "price": 100.50, "description": "We provide 24x7 customer service", @@ -14498,7 +14496,6 @@ Get all services for an account + (object) + serviceId: SERV10021056 (string) - Unique service identifier + name: Customer Service (string) - name of the service - + priceType: paid (string) - price type 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 @@ -14512,7 +14509,6 @@ Get all services for an account { "serviceId": "SERV10021056", "name": "Customer Service", - "priceType": "paid", "currencyCode": "USD", "price": 100.50, "description": "We provide 24x7 customer service", @@ -14568,7 +14564,6 @@ Update an existing service of an account. + 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. - + priceType: paid (string , required) - text of the service price type to be posted on Google Services profile ; 'paid' or 'free' value + 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 @@ -14581,7 +14576,6 @@ Update an existing service of an account. { "serviceId": "SERV10021056", "name": "Customer Service", - "priceType": "paid", "currencyCode": "USD", "price": 100.50, "description": "We provide 24x7 customer service", @@ -14731,7 +14725,6 @@ Get location level service - category mapping + (object) + serviceId: SERV10021056 (string) - Unique service identifier + name: Customer Service (string) - name of the service - + priceType: paid (string) - price type 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 @@ -14745,7 +14738,6 @@ Get location level service - category mapping { "serviceId": "SERV10021056", "name": "Customer Service", - "priceType": "paid", "currencyCode": "USD", "price": 100.50, "description": "We provide 24x7 customer service", @@ -14755,7 +14747,6 @@ Get location level service - category mapping { "serviceId": "SERV10021057", "name": "Marketing Service", - "priceType": "free", "description": "We provide 24x7 marketing service" } ], @@ -14763,7 +14754,6 @@ Get location level service - category mapping { "serviceId": "SERV10021058", "name": "Advertising Service", - "priceType": "paid", "currencyCode": "USD", "price": 100.50, "description": "We provide advertising service across various platforms", From 200886d9b365835bba3cc2c9fefe6a30303362d4 Mon Sep 17 00:00:00 2001 From: "vitthal.chandankar" Date: Thu, 19 Feb 2026 10:10:02 +0530 Subject: [PATCH 4/6] BIRD-183208: Removed api_key from request param and added x-api-key in the Headers to match the structure of armour rules --- apiary.apib | 39 +++++++++++++++++++++------------------ 1 file changed, 21 insertions(+), 18 deletions(-) diff --git a/apiary.apib b/apiary.apib index fd7563d..4bfed0a 100644 --- a/apiary.apib +++ b/apiary.apib @@ -14360,21 +14360,25 @@ Get all Unanswered Questions and Answers for a Location > - _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{?api_key,accountId}] +## 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{?api_key,accountId}] +### Create Service [POST /v1/google-services/service/create{?businessId}] + Parameters - + accountId: 169744180007807 (number, required) - Id of the account - + api_key: 2uiHKCTi8hSg35MG75aaot0B2SAokhjk (string, required) - Partner specific API key provided by Birdeye for data exchange. + + 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 @@ -14456,15 +14460,14 @@ Create a new service for the account -## Get All Services [/v1/google-services/services{?api_key,accountId,startIndex,pageSize,sortBy,sortOrder}] +## Get All Services [/v1/google-services/services{?businessId,startIndex,pageSize,sortBy,sortOrder}] Get all services for an account ### Get All Services [POST] + Parameters - + accountId: 169744180007807 (number, required) - Id of the account - + api_key: 2uiHKCTi8hSg35MG75aaot0B2SAokhjk (string, required) - Partner specific API key provided by Birdeye for data exchange. + + 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 @@ -14476,6 +14479,7 @@ Get all services for an account + Headers Accept: application/json + x-api-key: 2uiHKCTi8hSg35MG75aaot0B2SAokhjk (string, required) - Partner specific API key provided by Birdeye for data exchange. + Attributes @@ -14540,7 +14544,7 @@ Get all services for an account -## Update Service [/v1/google-services/service/update{?api_key,accountId}] +## Update Service [/v1/google-services/service/update{?businessId}] Update an existing service of an account. > __Note__ @@ -14550,8 +14554,7 @@ Update an existing service of an account. + Parameters - + accountId: 169744180007807 (number, required) - Id of the account - + api_key: 2uiHKCTi8hSg35MG75aaot0B2SAokhjk (string, required) - Partner specific API key provided by Birdeye for data exchange. + + businessId: 169744180007807 (number, required) - Id of the account + Request (application/json) @@ -14559,6 +14562,7 @@ Update an existing service of an account. + Headers Accept: application/json + x-api-key: 2uiHKCTi8hSg35MG75aaot0B2SAokhjk (string, required) - Partner specific API key provided by Birdeye for data exchange. + Attributes @@ -14639,7 +14643,7 @@ Update an existing service of an account. [2494][] -## Delete Services [/v1/google-services/service/delete{?api_key,accountId}] +## Delete Services [/v1/google-services/service/delete{?businessId}] Delete existing services of an account > __Note__ @@ -14649,14 +14653,14 @@ Delete existing services of an account + Parameters - + accountId: 169744180007807 (number, required) - Id of the account - + api_key: 2uiHKCTi8hSg35MG75aaot0B2SAokhjk (string, required) - Partner specific API key provided by Birdeye for data exchange. + + 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 @@ -14698,7 +14702,7 @@ Delete existing services of an account [2495][] -## Get Location Mapping [/v1/google-services/service/location-mapping{?api_key,businessId}] +## Get Location Mapping [/v1/google-services/service/location-mapping{?businessId}] Get location level service - category mapping ### Get Location Mapping [GET] @@ -14706,7 +14710,6 @@ Get location level service - category mapping + Parameters + businessId: 169744180007807 (number, required) - Id of the business - + api_key: 2uiHKCTi8hSg35MG75aaot0B2SAokhjk (string, required) - Partner specific API key provided by Birdeye for data exchange. + Request (application/json) @@ -14714,6 +14717,7 @@ Get location level service - category mapping + Headers Accept: application/json + x-api-key: 2uiHKCTi8hSg35MG75aaot0B2SAokhjk (string, required) - Partner specific API key provided by Birdeye for data exchange. + Response 200 (application/json) @@ -14784,7 +14788,7 @@ Get location level service - category mapping [2486][] -## Update Location Mapping [/v1/google-services/services/location-mapping{?api_key,businessId}] +## Update Location Mapping [/v1/google-services/services/location-mapping{?businessId}] Map services to categories at location level @@ -14796,14 +14800,13 @@ Map services to categories at location level + Parameters + businessId: 169744180007807 (number, required) - Id of the business - + api_key: 2uiHKCTi8hSg35MG75aaot0B2SAokhjk (string, required) - Partner specific API key provided by Birdeye for data exchange. - + Request (application/json) + Headers Accept: application/json + x-api-key: 2uiHKCTi8hSg35MG75aaot0B2SAokhjk (string, required) - Partner specific API key provided by Birdeye for data exchange. + Attributes From 06cf28b8e9c860d2129065aa6e8de320bd5b87c1 Mon Sep 17 00:00:00 2001 From: "vitthal.chandankar" Date: Mon, 23 Feb 2026 00:50:57 +0530 Subject: [PATCH 5/6] BIRD-183208: solved semantic issues --- apiary.apib | 80 +++++++++++++++++++++++++++-------------------------- 1 file changed, 41 insertions(+), 39 deletions(-) diff --git a/apiary.apib b/apiary.apib index 4bfed0a..ef2ab10 100644 --- a/apiary.apib +++ b/apiary.apib @@ -4471,14 +4471,13 @@ Get custom Fields List + Body - - { - "page":0, - "size": 50, - "searchStr": "colours", - "sortBy": "fieldDescription", - "orderBy": "asc" - } + { + "page":0, + "size": 50, + "searchStr": "colours", + "sortBy": "fieldDescription", + "orderBy": "asc" + } @@ -4741,7 +4740,7 @@ Updates an existing user’s access, notifications, and role. + lastName: Randy (string) - The last name of the user. + userRole: admin (string) - Role to assign within the application. + notification - user details - + sendReviewEmailAlert: (number) - Flag to enable sending of review email alerts. + + 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. @@ -11858,7 +11857,9 @@ Create webhook subscription listens to subscribed webhook events on a specific p + 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. @@ -11885,7 +11886,7 @@ Create webhook subscription listens to subscribed webhook events on a specific p + Body - { + { "webhookUrl": "https://webhook.site/2036c967-0174-4604-8b38-8d5493ed6d65", "emails": [ "test@xyz.com" @@ -11895,11 +11896,10 @@ Create webhook subscription listens to subscribed webhook events on a specific p "username": "testUser", "password": "userpassword" } - - - } + } + Response 200 (application/json) + { "id": "abcchdguweUGBSK16789278", "message": "You have successfully subscribed to : https://webhook.site/2036c967-0174-4604-8b38-8d5493ed6d65" @@ -11933,7 +11933,9 @@ Delete webhook subscription to stop listening to subscribed webhook events on th + 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. @@ -14429,7 +14431,7 @@ Create a new service for the account + Response 400 [2486][] - + + Response 400 [2487][] @@ -14441,19 +14443,19 @@ Create a new service for the account + Response 400 [2489][] - + + Response 400 [2490][] - + + Response 400 [2491][] - + + Response 400 [2492][] - + + Response 400 [2493][] @@ -14495,7 +14497,7 @@ Get all services for an account + Response 200 (application/json) + Attributes - + + services (array) - Google services details + (object) + serviceId: SERV10021056 (string) - Unique service identifier @@ -14505,7 +14507,7 @@ Get all services for an account + 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 { @@ -14521,7 +14523,7 @@ Get all services for an account } ] } - + + Response 401 [1161][] @@ -14605,11 +14607,11 @@ Update an existing service of an account. + Response 401 [1167][] - + + Response 400 [2486][] - + + Response 400 [2487][] @@ -14621,23 +14623,23 @@ Update an existing service of an account. + Response 400 [2489][] - + + Response 400 [2490][] - + + Response 400 [2491][] - + + Response 400 [2492][] - + + Response 400 [2493][] - + + Response 400 [2494][] @@ -14734,7 +14736,7 @@ Get location level service - category mapping + 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 { @@ -14766,7 +14768,7 @@ Get location level service - category mapping } ] } - + + Response 401 [1161][] @@ -14784,7 +14786,7 @@ Get location level service - category mapping [1167][] + Response 400 - + [2486][] @@ -14812,7 +14814,7 @@ Map services to categories at location level + category_name: Marketing (string , required) - name of the GMB category + service_id: [SERV10021056, SERV10021057] (array , required) - List of unique service identifier - + + Body { @@ -14841,7 +14843,7 @@ Map services to categories at location level + Response 400 [2486][] - + + Response 400 [2487][] @@ -14849,11 +14851,11 @@ Map services to categories at location level + Response 400 [2496][] - + + Response 400 [2493][] - + + Response 400 [2494][] @@ -15741,7 +15743,7 @@ Create Listing API publishes information on online listing sources. We post pres + 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: (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. + + 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”. @@ -16544,7 +16546,7 @@ The Update Listing API will update the location details on all your listings sit + 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: (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. + + 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”. @@ -17349,7 +17351,7 @@ The Get Listing API will get the listing information for the given business numb + 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: (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. + + 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”. @@ -19422,7 +19424,7 @@ Get tickets + status: new (string) - Ticket status. + rating: 5.0 (number) - Review rating. + externalId: 213243231 (string) - Public review id. - + description: Customer will visit again (number) - Description of the ticket. + + 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. From 16fbe04c97d401c727ed8ea9a788cc2d1495b9ca Mon Sep 17 00:00:00 2001 From: "vitthal.chandankar" Date: Mon, 23 Feb 2026 09:54:27 +0530 Subject: [PATCH 6/6] BIRD-183208: solved semantic issues --- apiary.apib | 29 +++++++++++++++-------------- 1 file changed, 15 insertions(+), 14 deletions(-) diff --git a/apiary.apib b/apiary.apib index ef2ab10..787b5c2 100644 --- a/apiary.apib +++ b/apiary.apib @@ -4785,17 +4785,17 @@ Updates an existing user’s access, notifications, and role. + sendBrokenIntegrationAlert: 1 (number) - Flag to enable in-app alerts for broken integrations. + sendBrokenIntegrationEmail: 1 (number) - Flag to enable email alerts for broken integrations. -+ Body + + Body - { - "locationsNumberAccess": [0], - user:{ - "firstName": "string", - "lastName": "string", - }, - "userRole": "string", - "notification": { /* as above */ } - } + { + "locationsNumberAccess": [0], + user:{ + "firstName": "string", + "lastName": "string", + }, + "userRole": "string", + "notification": { /* as above */ } + } + Response 200 (application/json) @@ -11940,9 +11940,10 @@ Delete webhook subscription to stop listening to subscribed webhook events on th x-api-key: [Required] Partner specific API key provided by Birdeye for data exchange. + Response 200 (application/json) - { - "message": "This Subscription has been Unsubscribed" - } + + { + "message": "This Subscription has been Unsubscribed" + } + Response 404 @@ -19590,7 +19591,7 @@ Get tickets # Group Integration Birdeye integrates with various software or tools you use. -## Add Business Integration Mapping[/v1/integrations/add/businessintegrationmapping] +## Add Business Integration Mapping [/v1/integrations/add/businessintegrationmapping] Add Business Integration Mapping adds locations to integrations and set them active. ### Add locations [PUT]