Listing || Google Suggestions Apis || {GET} || {POST}

apiary.apib

@@ -15727,6 +15727,105 @@ Google keyword: Top keywords searched for which your business is ranked.
 
     [2458][]
 
+## Get Google Suggestions [/resources/v1/listing/googleSuggestions{?status}]
+
+Google Suggestions allow businesses to access, review, and manage suggestions by approving or rejecting them as needed
+
+### Get Google Suggestions [GET]
+
++ Parameters
+    + status (optional, string) - Filter by status. Possible values: `Pending`, `Approved`, `Rejected`. If not passed, all suggestions are shown.
+
++ Request (application/json)
+    + Headers
+
+            api-key: [Required] Partner specific API key provided by Birdeye for data exchange.
+            businessId: 169744180007807 (number, required) - Business Number.
+
++ Response 200
+
+    + Attributes (object)
+        + totalCount: 2 (number) - Total number of Google Suggestions returned.
+        + result (array) - A list of suggestion objects.
+            + (object)
+                + suggestionId: 2435345 (number) - Unique identifier for the suggestion (auto generated).
+                + locationName: 100 NY Street (string) - Name or alias of the location for which suggestion is received.
+                + suggestedAttributeName: Phone Number (string) - Field for which suggestion is received from google.
+                + suggestedInput: +1 34567899004 (string) - Suggested input/value from google for the above field.
+                + birdeyeValue: +1 4667766545 (string) - Current value stored in the system.
+                + status: Approved (string) - Status of the suggestion. Possible values: `PENDING_REVIEW`, `Approved`, `Rejected`.
+                + lastActivity: Date MMM DD YYYY format (string) - Date and time for any last action performed over the suggestion.
+                + lastActivityByName: Michecl Smith (string) - Name of the user who last acted on the suggestion.
+                + suggestionReceivedDate: 23/04/2024 14:34:00 (string) - Initial Date and time when the suggestion was received from google.
+                + lastValueUpdatedOn: 23/04/2024 14:34:00 (string) - Date when any update or another suggestion received on top of the previous suggestion.
+                + userComments: Approved, effects All listings (string) - Comments added by the user while approving/rejecting the suggestion.
+
+    + Body
+
+            {
+               "totalCount": 2,
+               "result": [
+                   {
+                       "suggestionId": 2435345,
+                       "locationName": "100 NY Street",
+                       "suggestedAttributeName": "Phone Number",
+                       "suggestedInput": "+1 34567899004",
+                       "status": "Approved",
+                       "lastActivity": "Date MMM DD YYYY format",
+                       "lastActivityByName": "Michecl Smith",
+                       "birdeyeValue": "+1 4667766545",
+                       "suggestionReceivedDate": "",
+                       "lastValueUpdatedOn": "",
+                       "userComments": "Approved, effects All listings"
+                   },
+                   {
+                       "suggestionId": 2435345,
+                       "locationName": "100 NY Street",
+                       "suggestedAttributeName": "Category",
+                       "suggestedInput": "E-commerce",
+                       "birdeyeValue": "retail",
+                       "status": "PENDING_REVIEW",
+                       "lastActivity": "Date MMM DD YYYY format",
+                       "lastActivityByName": "Michecl Smith",
+                       "suggestionReceivedDate": "23/04/2024 14:34:00",
+                       "lastValueUpdatedOn": "",
+                       "userComments": null
+                   }
+               ]
+            }
+
+
+
+## Update Google Suggestions [/resources/v1/listing/update/GoogleSuggestions]
+
+API to approve or reject Google Suggestions by providing suggestion IDs and the corresponding action.
+
+### Update Google Suggestions [POST]
+
++ Request (application/json)
+    + Headers
+
+            api-key: [Required] Partner specific API key provided by Birdeye for data exchange.
+            businessId: 169744180007807 (number, required) - Business Number.
+
+    + Attributes (object)
+        + suggestionIds: [12345, 56789] (array[number], required) - List of suggestion IDs selected by user to be approved or rejected.
+        + action: approved (string, required) - user wants to approve or rejects these suggestions based on that value will be set. Possible values: `approved`, `rejected`.
+
+    + Body
+
+            {
+               "suggestionIds": [12345,56789],
+               "action": "approved"
+            }
+
++ Response 200 (application/json)
+
+        {
+           "code":200,
+           "message":"suggestion(s) processed successfully"
+        }
+
 ## 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).