From 5769b60bb308759648a87c0c9e6ddba73bfec483 Mon Sep 17 00:00:00 2001 From: ishanRathi Date: Fri, 12 Apr 2024 13:50:11 +0530 Subject: [PATCH 1/4] Changes for API doc --- apiary.apib | 1038 ++++++++++++++++++++++++++++++++++++++++++++------- 1 file changed, 906 insertions(+), 132 deletions(-) diff --git a/apiary.apib b/apiary.apib index 42e7fc5..00bc29d 100644 --- a/apiary.apib +++ b/apiary.apib @@ -1925,6 +1925,102 @@ For example : "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" + } # Group Business Create and maintain your business on Birdeye. @@ -14043,128 +14139,94 @@ Deactivate Listing API stops publishing any information on the given online dire [89][] +## Create Question [/v1/qna/question/create{?api_key,businessId}] +Create new Question on Google Q&A section of your business -# Group Ticketing -Create standout customer support with ticketing across reviews, untagged, and survey responses. - -## Create ticket [/resources/v1/ticket/{businessNumber}/create-ticket] -Create reviews, untagged, and survey responses tickets. - -### Create ticket [PUT] +### Create Question [POST] + Parameters - - + businessNumber: 12345678 (number, required) - Business number of the location on which we want to create a ticket. - + + businessId: 12345678 (string, required) - Id of the business. + + api_key: abcdefgh (string, required) - Partner specific API key provided by Birdeye for data exchange. + Request (application/json) + Headers Accept: application/json - api_key: abcdefgh (string, required) - Partner specific API key provided by Birdeye for data exchange. + api_key: - 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 - - - - + + question: Enter question here (string , required ) - text of the question to be posted on Google Q&A profile ; minimum 3 word and 10 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 + 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" + "question": "Enter question here", + "answer": "Enter answer here" } ++ Response 200 (application/json) -+ Response 200 + Attributes - + ticketId: 882382 (number) - Id of the new ticket created. - - - + + question_id: 2892 (number) - unique question identifier + + Body { - "ticketId": 882382 + "question_id":2892 } - + Response 401 [1161][] ++ Response 429 + + [89][] + ++ Response 404 + + [1011][] + + Response 401 [1167][] -+ Response 429 ++ Response 401 - [89][] + [2478][] + ++ Response 401 + [2479][] + Response 401 - [1033][] + [2481][] ++ Response 401 -+ Response 404 + [2485][] + ++ Response 401 - [1175][] + [2483][] +## Create Answer [/v1/qna/answer/create{?api_key,businessId}] +Add Answer to Existing Question. Owner can add only one answer per question -## Add Ticket Comments [/resources/v1/ticket/{businessNumber}/comment-activity] -Add comment activity on tickets. -### Add Ticket Comments [POST] -+ Parameters +### Create Answer [POST] - + businessNumber: 12345678 (number, required) - Business number of the location. ++ Parameters + + businessId: 12345678 (string, required) - Id of the business. + + api_key: abcdefgh (string, required) - Partner specific API key provided by Birdeye for data exchange. + Request (application/json) @@ -14172,71 +14234,89 @@ Add comment activity on tickets. + Headers Accept: application/json - api_key: abcdefgh (string, required) - Partner specific API key provided by Birdeye for data exchange. + api_key: - 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. - + + 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 + Body { - "comment": "Had a chat with customer, he will visit again.", - "ticketId": "886172", - "userEmail": "steve@ymail.com" + "questionId": 7812, + "answer": "Enter answer here" } ++ Response 200 (application/json) -+ Response 200 + Attributes - + ticketId: 882382 (number) - Id of the new ticket created. - - - + + answer_id: 2893 (string) - unique answer identifier + + Body { - "ticketId": 882382 + "answer_id":2893 } - + Response 401 [1161][] ++ Response 429 + + [89][] + ++ Response 404 + + [1011][] + + Response 401 [1167][] -+ Response 429 ++ Response 401 - [89][] + [2478][] + ++ Response 401 + [2479][] + + Response 401 - [1033][] + [2481][] + ++ Response 401 -+ Response 404 + [2485][] + ++ Response 401 - [1175][] + [2483][] ++ Response 401 + [2461][] + ++ Response 401 + [2462][] -## Update ticket [/resources/v1/ticket/{businessNumber}/update] -Update the ticket status or ticket assignee. +## Update Question [/v1/qna/question/update{?api_key,businessId}] +Update an existing question -### Update ticket [PUT] -+ Parameters - + businessNumber: 12345678 (number, required) - Business number of the location. +### Update Question [PUT] + + ++ Parameters + + businessId: 12345678 (string, required) - Id of the business. + + api_key: abcdefgh (string, required) - Partner specific API key provided by Birdeye for data exchange. + Request (application/json) @@ -14244,69 +14324,82 @@ Update the ticket status or ticket assignee. + Headers Accept: application/json - api_key: abcdefgh (string, required) - Partner specific API key provided by Birdeye for data exchange. + api_key: - 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. + + 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 + Body { - "ticketUpdateMessages": [{ - "assignedTo": "steve@ymail.com", - "ticketId": "882382", - "ticketStatus": "assigned" - }], - "userEmail": "pranav.singh@birdeye.com" + "questionId": 7812, + "question": "Enter question here" } - -+ Response 200 ++ Response 200 (application/json) + Response 401 [1161][] ++ Response 429 + + [89][] + ++ Response 404 + + [1011][] + + Response 401 [1167][] -+ Response 429 ++ Response 401 - [89][] + [2478][] + ++ Response 401 + [2479][] + + Response 401 - [1033][] + [2481][] + ++ Response 401 -+ Response 404 + [2485][] + ++ Response 401 - [1175][] + [2483][] ++ Response 401 + [2461][] + ++ Response 401 + [2480][] ++ Response 401 + [2482][] -## Get All Ticket Data [/resources/v1/ticket/{businessNumber}/get/all?{?op,sortOrder,count,sIndex,sortBy,totalCount}] -Get tickets -### Get All Ticket Data [POST] -+ Parameters +## Update Answer [/v1/qna/answer/update{?api_key,businessId}] +Update an answer to an existing question + + + +### Update Answer [PUT] - + businessNumber: 12345678 (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 ++ Parameters + + businessId: 12345678 (string, required) - Id of the business. + + api_key: abcdefgh (string, required) - Partner specific API key provided by Birdeye for data exchange. + Request (application/json) @@ -14314,12 +14407,595 @@ Get tickets + Headers Accept: application/json - api_key: abcdefgh (string, required) - Partner specific API key provided by Birdeye for data exchange. + api_key: - 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. + + 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 + + + + 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{?api_key,businessId}] +Delete existing questions. Only that question can be deleted which is posted by the owner. + + + +### Delete Question [POST] + ++ Parameters + + businessId: 12345678 (string, required) - Id of the business. + + api_key: abcdefgh (string, required) - Partner specific API key provided by Birdeye for data exchange. + + ++ Request (application/json) + + + Headers + + Accept: application/json + 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{?api_key,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. + + api_key: abcdefgh (string, required) - Partner specific API key provided by Birdeye for data exchange. + + ++ Request (application/json) + + + Headers + + Accept: application/json + 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{?api_key,businessId}] +Delete all A&A on the businessId provided. + + + +### Delete All Questions and Answers [DELETE] + ++ Parameters + + businessId: 12345678 (string, required) - Id of the business. + + api_key: abcdefgh (string, required) - Partner specific API key provided by Birdeye for data exchange. + + ++ Request (application/json) + + + Headers + + Accept: application/json + 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][] + + + + + +# Group Ticketing +Create standout customer support with ticketing across reviews, untagged, and survey responses. + +## Create ticket [/resources/v1/ticket/{businessNumber}/create-ticket] +Create reviews, untagged, and survey responses tickets. + +### Create ticket [PUT] + ++ Parameters + + + businessNumber: 12345678 (number, required) - Business number of the location on which we want to create a ticket. + + ++ Request (application/json) + + + Headers + + Accept: application/json + api_key: abcdefgh (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 [/resources/v1/ticket/{businessNumber}/comment-activity] +Add comment activity on tickets. + +### Add Ticket Comments [POST] + ++ Parameters + + + businessNumber: 12345678 (number, required) - Business number of the location. + + ++ Request (application/json) + + + Headers + + Accept: application/json + api_key: abcdefgh (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 [/resources/v1/ticket/{businessNumber}/update] +Update the ticket status or ticket assignee. + + +### Update ticket [PUT] + ++ Parameters + + + businessNumber: 12345678 (number, required) - Business number of the location. + + ++ Request (application/json) + + + Headers + + Accept: application/json + api_key: abcdefgh (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 [/resources/v1/ticket/{businessNumber}/get/all?{?op,sortOrder,count,sIndex,sortBy,totalCount}] +Get tickets + +### Get All Ticket Data [POST] + ++ Parameters + + + businessNumber: 12345678 (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 + api_key: abcdefgh (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. @@ -14516,8 +15192,106 @@ Get tickets [1175][] + +## Get All Questions and Answers[/v1/qna/get{?api_key,businessId}] +Get all Questions and Answers for a Business + +### Get All Questions and Answers [POST] + ++ Parameters + + businessId: 12345678 (string, required) - Id of the business. + + api_key: abcdefgh (string, required) - Partner specific API key provided by Birdeye for data exchange. + ++ Request (application/json) + + + Headers + + Accept: application/json + api_key: - Partner specific API key provided by Birdeye for data exchange. + + + Attributes + + startIndex: 25 (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) - Ticket Details. + + (object) + + questionId: 188556 (number) - Unique question identifier. + + answeredByOwner: true (boolean) - Status of owner answer. + + 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 the person who + + 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 + + { + "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][] # Group Integration Birdeye integrates with various software or tools you use. From 38cc6e2e97e752f04d08bf21540d29be87e56dbe Mon Sep 17 00:00:00 2001 From: ishanRathi Date: Fri, 12 Apr 2024 14:43:57 +0530 Subject: [PATCH 2/4] API doc changes for Google Q&A --- apiary.apib | 221 ++++++++++++++++++++++++++++------------------------ 1 file changed, 119 insertions(+), 102 deletions(-) diff --git a/apiary.apib b/apiary.apib index 00bc29d..2b8f667 100644 --- a/apiary.apib +++ b/apiary.apib @@ -2021,6 +2021,14 @@ For example : "code": 2462, "message": "Owner answer already added please edit answer" } +## 2466 [/2466] + ++ Model (application/json) + + { + "code": 2466, + "message": "Invalid input request" + } # Group Business Create and maintain your business on Birdeye. @@ -14719,8 +14727,117 @@ Delete all A&A on the businessId provided. [2482][] - - +## Get All Questions and Answers [/v1/qna/get{?api_key,businessId}] +Get all Questions and Answers for a Business + +### Get All Questions and Answers [POST] + ++ Parameters + + businessId: 12345678 (string, required) - Id of the business. + + api_key: abcdefgh (string, required) - Partner specific API key provided by Birdeye for data exchange. + ++ Request (application/json) + + + Headers + + Accept: application/json + api_key: - Partner specific API key provided by Birdeye for data exchange. + + + Attributes + + startIndex: 25 (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 h:mm a + + updatedOn: Apr 10, 2024 (string) - Date at which question was created/updated MMM d, 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 d, yyyy + + time: 10:52 PM (string) - time at which answer was created/updated format: h:mm a + + 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][] + # Group Ticketing Create standout customer support with ticketing across reviews, untagged, and survey responses. @@ -15193,106 +15310,6 @@ Get tickets [1175][] -## Get All Questions and Answers[/v1/qna/get{?api_key,businessId}] -Get all Questions and Answers for a Business - -### Get All Questions and Answers [POST] - -+ Parameters - + businessId: 12345678 (string, required) - Id of the business. - + api_key: abcdefgh (string, required) - Partner specific API key provided by Birdeye for data exchange. - -+ Request (application/json) - - + Headers - - Accept: application/json - api_key: - Partner specific API key provided by Birdeye for data exchange. - - + Attributes - + startIndex: 25 (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) - Ticket Details. - + (object) - + questionId: 188556 (number) - Unique question identifier. - + answeredByOwner: true (boolean) - Status of owner answer. - + 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 the person who - + 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 - - { - "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][] - # Group Integration Birdeye integrates with various software or tools you use. From 42cc9d386b21808979b72a5e60e251325828bc8b Mon Sep 17 00:00:00 2001 From: ishanRathi Date: Mon, 29 Apr 2024 14:41:18 +0530 Subject: [PATCH 3/4] Changes for Google Q&A section API DOCS --- apiary.apib | 5817 ++++++++++++++++++++++++++------------------------- 1 file changed, 2915 insertions(+), 2902 deletions(-) diff --git a/apiary.apib b/apiary.apib index 2b8f667..cb93866 100644 --- a/apiary.apib +++ b/apiary.apib @@ -11343,37 +11343,55 @@ Get Keyword Statistics retrieves Insights keywords details for a competitor. [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_ -# Group Listing -Keep your business information accurate and consistent across 50+ websites. - +## Create Question [/v1/qna/question/create{?api_key,businessId}] +Create a new question and associated answer -## Fix Listing [/v1/listing/fix{?api_key,b_id}] -Fix Listing publishes information on online listing sources. We post presence information on more than 50 online directories. +> __Best practise__ +> - _Please ensure that a business appropriate question and associated answer is created. Recommendation is to create typical FAQ like questions._ -### Fix Listing [POST] +### Create Question [POST] + Parameters - - + b_id: 12345678 (number, required) - Id of the business. + + businessId: 12345678 (string, required) - Id of the business. + api_key: abcdefgh (string, required) - Partner specific API key provided by Birdeye for data exchange. - + Request (application/json) + Headers Accept: application/json + 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 + + answer: Enter answer here (string,required) - text of the answer to be posted on Google Q&A profile ; minimum 1 one non-space character + + Body { + "question": "Enter question here", + "answer": "Enter answer here" } -+ Response 200 ++ Response 200 (application/json) + + + + Attributes + + question_id: 2892 (number) - unique question identifier + + + Body + + { + "question_id":2892 + } + Response 401 @@ -11383,110 +11401,79 @@ Fix Listing publishes information on online listing sources. We post presence in [89][] ++ Response 404 + + [1011][] + + Response 401 [1167][] -+ Response 404 ++ Response 401 - [1175][] + [2478][] + ++ Response 401 -## Get Location Status [/v1/listing/{businessNumber}/location/status] -Get Location Status retrieves status for each sources for a given business. Health aggregates sum and percentage metrics for distinct statuses. + [2479][] ++ Response 401 -### Get Location Status [GET] + [2481][] ++ Response 401 + + [2485][] + ++ Response 401 + + [2483][] + + + +## Create Answer [/v1/qna/answer/create{?api_key,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. + + api_key: abcdefgh (string, required) - Partner specific API key provided by Birdeye for data exchange. - + businessNumber: 12345678 (number, required) - Id of the business. + Request (application/json) + Headers Accept: application/json - api_key: [Required] Partner specific API key provided by Birdeye for data exchange. + 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 -+ Response 200 - + Attributes - + listingStatus (array) - List of location status. - + sourceName: Google (string) - Name of listing source. - + status: Action Required (string) - Status of the location on that source. Possible values are : - Sync Initiated, - In Progress, - Opted out, - Submitted, - Live, - Action Required, - Connect, - Reconnect, - Unavailable. - + liveLink: https://maps.google.com/maps?cid=151047735163 (string) - Location source link. - + name: Utah Dental Center (string) - Name of the location. - + phone (string) - Phone number Format is (xxx) xxx-xxxx. - + address: 420 E S Temple St #220 (string) - Address of the business. - + health (array) - Aggregates sum and percentage metrics for distinct statuses + + Body + + { + "questionId": 7812, + "answer": "Enter answer here" + } + + ++ Response 200 (application/json) + + Attributes + + answer_id: 2893 (string) - unique answer identifier + + Body { - "listingStatus": [{ - "sourceName": "Navmii", - "status": "Action Required", - "liveLink": "http://livepoi.navmii.com/p/view/4d6c-ace0-0a2483b47182", - "name": "Richard L. Blackhurst/Utah Dental Center", - "phone": "(123) 456-7890", - "address": "420 E S Temple St #220" - }, - { - "sourceName": "Where To?", - "status": "In Progress", - "liveLink": "https://wheretoapp.com/search?poi=86183685562887", - "name": "Richard L. Blackhurst/Utah Dental Center", - "phone": "(123) 456-0987", - "address": "420 E S Temple St #220" - }], - "health": [ - { - "status": "Action Required", - "count": 1, - "percentage": 14.29 - }, - { - "status": "In Progress", - "count": 1, - "percentage": 14.29 - }, - { - "status": "Reconnect", - "count": 1, - "percentage": 14.29 - }, - { - "status": "Connect", - "count": 1, - "percentage": 14.29 - }, - { - "status": "Live", - "count": 1, - "percentage": 14.29 - }, - { - "status": "Opted out", - "count": 1, - "percentage": 14.29 - }, - { - "status": "Sync Initiated", - "count": 1, - "percentage": 14.29 - } - ] - } + "answer_id":2893 + } + Response 401 @@ -11496,81 +11483,78 @@ Get Location Status retrieves status for each sources for a given business. Heal [89][] ++ Response 404 + + [1011][] + + Response 401 [1167][] -+ Response 404 ++ Response 401 - [1175][] + [2478][] + ++ Response 401 + [2479][] + ++ Response 401 -## Listings Insights [/v1/listing/insights{?api_key,businessId}] -Insights/Analytics for Google Listings of a given business. + [2481][] + ++ Response 401 -### Listings Insights [POST] + [2485][] + ++ Response 401 -+ Parameters + [2483][] ++ Response 401 - + api_key: abcdefgh (string, required) - Partner specific API key provided by Birdeye for data exchange. - + businessId: 12345678 (number, required) - Id of the account. + [2461][] + ++ Response 401 -+ Request (application/json) + [2462][] - + Headers - Accept: application/json +## Update Question [/v1/qna/question/update{?api_key,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. - + 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” +### Update Question [PUT] - + Body - { - "businessNumbers": [156387109031976], - "startDate": "2010-02-01", - "endDate": "2022-02-01", - "viewMode": [ "Mobile"] - } ++ Parameters + + businessId: 12345678 (string, required) - Id of the business. + + api_key: abcdefgh (string, required) - Partner specific API key provided by Birdeye for data exchange. + ++ Request (application/json) + + Headers -+ Response 200 + Accept: application/json + 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 - + 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. - + 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. - + websiteVisitsTotalCount: 2868 (number) - The number of times the business profile website was clicked. - + getDirectionsTotalCount: 0 (number) - The number of times a direction request was requested to the business location. - + callsTotalCount: 2868 (number) - The number of times the business profile call button was clicked. - + usersReachedTotalCount: 0 (number) - The number of times your business appeared in search results and other services in Bing. - + impressionCountTotalCount: 0 (number) - The number of users who saw the activity from your page including posts, check-ins, and ads. - + liveCount: 10 (number) - Total no of synched sites for a business. - + entityCount: 1 (number) - Total businesses count. - + viewMode (array) - is data required for mobile or desktop or both (if none is provided then data for both will be displayed) + Body { - "mapViewTotalCount": 2868, - "searchViewTotalCount": 2868, - "websiteVisitsTotalCount": 2868, - "getDirectionsTotalCount": 0, - "callsTotalCount": 2868, - "usersReachedTotalCount": 0, - "impressionCountTotalCount": 0, - "liveCount": 10, - "entityCount": 1 + "questionId": 7812, + "question": "Enter question here" } ++ Response 200 (application/json) + + Response 401 [1161][] @@ -11579,26 +11563,57 @@ Insights/Analytics for Google Listings of a given business. [89][] ++ Response 404 + + [1011][] + + Response 401 [1167][] -+ Response 404 - - [1175][] ++ Response 401 + [2478][] + ++ Response 401 + [2479][] + ++ Response 401 -## Listings Insights Datapoints [/v1/listing/report/{reportType}/datapoints{?api_key,businessId}] -Datapoints of report graph is date/label mapped to value/data of a given business. + [2481][] + ++ Response 401 -### Listings Insights Datapoints [POST] + [2485][] + ++ Response 401 -+ Parameters + [2483][] ++ Response 401 + + [2461][] + ++ Response 401 + [2480][] ++ Response 401 + + [2482][] + + + +## Update Answer [/v1/qna/answer/update{?api_key,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. + api_key: abcdefgh (string, required) - Partner specific API key provided by Birdeye for data exchange. - + 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) @@ -11606,184 +11621,107 @@ Datapoints of report graph is date/label mapped to value/data of a given busines + Headers Accept: application/json + api_key: - 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 + + 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 + Body { - "businessNumbers": [156387109031976], - "startDate": "2010-02-01", - "endDate": "2022-02-01", - "groupByType": "year", - "viewMode": [ "Mobile"] + "questionId": 7812, + "answerId": 7813, + "question": "Enter answer here" } ++ Response 200 (application/json) -+ Response 200 ++ Response 401 - + 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. + [1161][] - + Body ++ Response 429 - [{ - "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 - } - ] + [89][] ++ Response 404 + + [1011][] + Response 401 - [1161][] + [1167][] -+ Response 429 ++ Response 401 - [89][] + [2478][] + ++ Response 401 + [2479][] + + Response 401 - [1167][] + [2481][] + ++ Response 401 -+ Response 404 + [2485][] + ++ Response 401 - [1175][] + [2483][] ++ Response 401 + [2461][] + ++ Response 401 + [2480][] ++ Response 401 -## 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 + [2482][] + +## Delete Question [/v1/qna/question/delete{?api_key,businessId}] +Delete existing questions. Only those questions can be deleted which are created by the owner. -### Get GMB Attributes [GET] +> __Note__ +> - _Associated answers with the question will also be deleted._ + + + +### Delete Question [POST] + Parameters + + businessId: 12345678 (string, required) - Id of the business. + + api_key: abcdefgh (string, required) - Partner specific API key provided by Birdeye for data exchange. - + businessNumber: 12345678 (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 - api_key: [Required] Partner specific API key provided by Birdeye for data exchange. - - -+ Response 200 + api_key: - Partner specific API key provided by Birdeye for data exchange. + 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. + + questionId: 7812 (number , required ) - unique question identifier + + 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" - }] - }] + "questionId": 7812 + } ++ Response 200 (application/json) + Response 401 @@ -11793,77 +11731,79 @@ The Get GMB Attributes API fetches the list of applicable GMB attributes for the [89][] ++ Response 404 -+ Response 400 + [1011][] - [4011][] ++ Response 401 -+ Response 400 + [1167][] - [4012][] ++ Response 401 -+ Response 400 + [2478][] + ++ Response 401 - [4013][] + [2479][] + ++ Response 401 + [2481][] + ++ Response 401 -## 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. + [2485][] + ++ Response 401 + [2483][] ++ Response 401 -### Get Apple Attributes [GET] + [2461][] + ++ Response 401 -+ Parameters + [2480][] ++ Response 401 - + businessNumber: 12345678 (number, required) - Business Number. + [2482][] -+ Request (application/json) +## Delete Answer [/v1/qna/answer/delete{?api_key,businessId}] +Delete answers to existing questions. Only that answer can be deleted which is posted by the owner. - + Headers - Accept: application/json - api_key: [Required] Partner specific API key provided by Birdeye for data exchange. +### Delete Answer [POST] + ++ Parameters + + businessId: 12345678 (string, required) - Id of the business. + + api_key: abcdefgh (string, required) - Partner specific API key provided by Birdeye for data exchange. -+ Response 200 ++ Request (application/json) + + + Headers + + Accept: application/json + api_key: - Partner specific API key provided by Birdeye for data exchange. + Attributes - + Accessibility (array) - This is dynamic field. Depends upon request inputs. - + (object) + + questionId: 7812 (number , required ) - unique question identifier + + answerId: 7813 (number , required ) - unique answer identifier + + + 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": [] - - + "questionId": 7812, + "answerId":7813 + } ++ Response 200 (application/json) + Response 401 @@ -11873,153 +11813,80 @@ The Get Apple Attributes API fetches the list of applicable Apple attributes. An [89][] ++ Response 404 -+ 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: 12345678 (number, required) - Business Number. - -+ Request (application/json) - - - + Headers - - Accept: application/json - 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" - } - + [1011][] - ] ++ Response 401 + [1167][] ++ Response 401 + [2478][] + + Response 401 - [1161][] + [2479][] + ++ Response 401 -+ Response 429 + [2481][] + ++ Response 401 - [89][] + [2485][] + ++ Response 401 + [2483][] ++ Response 401 -+ Response 400 + [2461][] + ++ Response 401 - [4011][] + [2480][] ++ Response 401 -+ Response 400 + [2482][] - [4012][] -+ Response 400 +## Delete All Questions and Answers [/v1/qna/question/deleteAll{?api_key,businessId}] +Delete all A&A on the businessId provided. - [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] +### Delete All Questions and Answers [DELETE] + Parameters + + businessId: 12345678 (string, required) - Id of the business. + + api_key: abcdefgh (string, required) - Partner specific API key provided by Birdeye for data exchange. - + businessNumber: 12345678 (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 - 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” + 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 - [ - { - "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 - } - ] - + { + "questionId": 7812, + "answerId":7813 + + } ++ Response 200 (application/json) + Response 401 @@ -12029,1902 +11896,598 @@ The Get Category List API fetches the list of category values for the selected s [89][] ++ Response 404 -+ Response 400 + [1011][] - [4014][] ++ Response 401 -+ Response 400 + [1167][] - [4012][] ++ Response 401 -+ Response 400 + [2478][] + ++ Response 401 - [4013][] + [2479][] + ++ Response 401 -+ Response 400 + [2481][] + ++ Response 401 - [4015][] + [2485][] + ++ Response 401 + [2483][] ++ Response 401 -## 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. + [2461][] + ++ Response 401 + [2480][] ++ Response 401 -### Create Listing [POST] + [2482][] -+ Parameters - + businessNumber: 12345678 (number, required) - Business Number. +## Get All Questions and Answers [/v1/qna/get{?api_key,businessId}] +Get all Questions and Answers for a Location -+ Request (application/json) +### Get All Questions and Answers [POST] + ++ Parameters + + businessId: 12345678 (string, required) - Id of the business. + + api_key: abcdefgh (string, required) - Partner specific API key provided by Birdeye for data exchange. ++ Request (application/json) + Headers Accept: application/json - api_key: [Required] Partner specific API key provided by Birdeye for data exchange. + api_key: - 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/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. - + 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. - + 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. - + 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. - + 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) - It will update your business status on lisitng page and If business will choose "Temporarily closed" then Reopen date is mandatry. [Open, Temporarily closed, Permanently closed] - + reopenDate : 10/20/2022 - Reopen date is applicable only when the status is "temporarily closed". It should be "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 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. - + 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. - + categories (string) - 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. - + 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) - 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 - + category (string) - 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. - + additionalCategory (string) - You can add up to 5 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 - + 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. - + 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. - + 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 + + Attributes + + startIndex: 25 (number , required ) - start index + + pageSize: 25 (number,required) - page size + Body { - "businessInfo": { - "name": "Dieci Lifestyle Spa", - "phone": "(973) 716-0007", - "websiteUrl": "http://www.diecispa.org/", - "emailId": "example@birdeye.com", - "isAddressHidden": "No", - "isServiceAreaProvider": "No", - "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. & N. Mitchell Ave.)", - "city": "Livingston", - "state": "NJ", - "zip": "07039", - "countryCode": "US" + "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 h:mm a + + updatedOn: Apr 10, 2024 (string) - Date at which question was created/updated MMM d, 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 d, yyyy + + time: 10:52 PM (string) - time at which answer was created/updated format: h:mm a + + 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" + } + ] } - }, - "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" - } - ] - } - ] - }, - "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", - "payment": "Visa,MasterCard,AmericanExpress,DebitCards,Check", - "localPhoneNumber": "(973)716-0102", - "tollFreePhoneNumber": "", - "iosAppURL": "http://www.gmail.com", - "androidAppURL": "http://www.gmail.com" - }, - "media": { - "logoUrl": "http://d2xt3xymj142xp.cloudfront.net/712586432/other/ab60b93831ba490383b9c59c0b4cf49d.jpeg", - "coverImageUrl": "http://d2xt3xymj142xp.cloudfront.net/712586432/other/ab60b93831ba490383b9c59c0b4cf49d.jpeg", - "gmbCover": "http://d3cnqzq0ivprch.cloudfront.net/common/css/images/profile/abcd.jpg", - "facebookCover": "http://d3cnqzq0ivprch.cloudfront.net/common/css/images/profile/fb.jpg" - - }, - "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": "Storage facility", - "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" - }, - "appleListing": { - "primaryCategory": "active.amateursportsteams", - "additionalCategories": [ - "active.publicplazas", - "auto.autoelectric", - "auto.autoelectric" - ], - "appleLocationAttributes": { - "crossbusiness.accessibility_features": [{ - "attributeId": "accessible_elevator" - } - ], - "crossbusiness.family_kids": [{ - "attributeId": "kidsclub" - },{ - "attributeId": "parents_waitingarea" - } - ] - }, - "appleActionLinks": [{ - "id": "quicklinks.airline_book_travel", - "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": "", - "lendingtreeUrl": "" - }, - "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][] - - -## 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: 12345678 (number, required) - Business Number. - -+ Request (application/json) - - - + Headers - - Accept: application/json - 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/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. - + 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. - + 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. - + 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. - + 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) - It will update your business status on lisitng page and If business will choose "Temporarily closed" then Reopen date is mandatry. [Open, Temporarily closed, Permanently closed] - + reopenDate : 10/20/2022 - Reopen date is applicable only when the status is "temporarily closed". It should be "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 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. - + 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. - + categories (string) - 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. - + 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) - 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 - + category (string) - 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. - + additionalCategory (string) - You can add up to 5 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 - + 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. - + 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. - + 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", - "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. & 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" - } - ] - } - ] - }, - "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", - "payment": "Visa,MasterCard,AmericanExpress,DebitCards,Check", - "localPhoneNumber": "(973)716-0102", - "tollFreePhoneNumber": "", - "iosAppURL": "http://www.gmail.com", - "androidAppURL": "http://www.gmail.com" - }, - "media": { - "logoUrl": "http://d2xt3xymj142xp.cloudfront.net/712586432/other/ab60b93831ba490383b9c59c0b4cf49d.jpeg", - "coverImageUrl": "http://d2xt3xymj142xp.cloudfront.net/712586432/other/ab60b93831ba490383b9c59c0b4cf49d.jpeg", - "gmbCover": "http://d3cnqzq0ivprch.cloudfront.net/common/css/images/profile/abcd.jpg", - "facebookCover": "http://d3cnqzq0ivprch.cloudfront.net/common/css/images/profile/fb.jpg" - }, - "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": "Alok 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 Alok 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": "Storage facility", - "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" - }, - "appleListing": { - "primaryCategory": "active.amateursportsteams", - "additionalCategories": [ - "active.publicplazas", - "auto.autoelectric", - "auto.autoelectric" - ], - "appleLocationAttributes": { - "crossbusiness.accessibility_features": [{ - "attributeId": "accessible_elevator" - } - ], - "crossbusiness.family_kids": [{ - "attributeId": "kidsclub" - },{ - "attributeId": "parents_waitingarea" - } - ] - }, - "appleActionLinks": [{ - "id": "quicklinks.airline_book_travel", - "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": "", - "lendingtreeUrl": "" - }, - "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][] - - -## 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: 12345678 (number, required) - Business Number. - -+ Request (application/json) - - - + Headers - - Accept: application/json - 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. - + 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. - + 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) - It will update your business status on lisitng page and If business will choose "Temporarily closed" then Reopen date is mandatry. [Open, Temporarily closed, Permanently closed] - + reopenDate : 10/20/2022 - Reopen date is applicable only when the status is "temporarily closed". It should be "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 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 (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. - + categories (string) - 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. - + 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) - 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 - + category (string) - 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. - + additionalCategory (string) - You can add up to 5 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 - + 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. - + 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. - + 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 + ] + } + ++ Response 401 + [1161][] - + Body ++ Response 429 - { - "businessInfo": { - "name": "Dieci Lifestyle Spa", - "phone": "(973) 716-0007", - "websiteUrl": "http://www.diecispa.org/", - "emailId": "example@birdeye.com", - "isAddressHidden": "No", - "isServiceAreaProvider": "No", - "serviceAreas": [ - { - "description": "Van An, Berryessa Road, San Jose, CA, USA", - "placeId": "ChIJc_clvUTMj4AR_K0M2GO2CYg" - }, - { - "description": "Santa Clara, CA, USA", - "placeId": "ChIJk8EIXIG3j4ARwL_Ao3ykdeQ" - } - ], - "location": { - "address1": "90 W Mount Pleasant Ave", - "address2": "(btwn Preston Dr. & 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" - } - ] - } - ] - }, - "wholeWeekOperating": 0, - "hoursOfOperations": [ - { - "day": 0, - "isOpen": 1, - "workingHours": [ - { - "startHour": "09:00", - "endHour": "13:30" - }, - { - "startHour": "14:30", - "endHour": "19:00" - } - ] - }, + [89][] + ++ Response 404 + + [1011][] + ++ Response 401 + + [1167][] + ++ Response 401 + + [2466][] + + + +# Group Listing +Keep your business information accurate and consistent across 50+ websites. + + +## Fix Listing [/v1/listing/fix{?api_key,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. + + api_key: abcdefgh (string, required) - Partner specific API key provided by Birdeye for data exchange. + + ++ Request (application/json) + + + Headers + + Accept: application/json + + + Body + + { + } + + ++ Response 200 + ++ Response 401 + + [1161][] + ++ Response 429 + + [89][] + ++ Response 401 + + [1167][] + ++ Response 404 + + [1175][] + +## Get Location Status [/v1/listing/{businessNumber}/location/status] +Get Location Status retrieves status for each sources for a given business. Health aggregates sum and percentage metrics for distinct statuses. + +### Get Location Status [GET] + ++ Parameters + + + businessNumber: 12345678 (number, required) - Id of the business. + ++ Request (application/json) + + + Headers + + Accept: application/json + api_key: [Required] Partner specific API key provided by Birdeye for data exchange. + + ++ Response 200 + + + Attributes + + listingStatus (array) - List of location status. + + sourceName: Google (string) - Name of listing source. + + status: Action Required (string) - Status of the location on that source. Possible values are : + Sync Initiated, + In Progress, + Opted out, + Submitted, + Live, + Action Required, + Connect, + Reconnect, + Unavailable. + + liveLink: https://maps.google.com/maps?cid=151047735163 (string) - Location source link. + + name: Utah Dental Center (string) - Name of the location. + + phone (string) - Phone number Format is (xxx) xxx-xxxx. + + address: 420 E S Temple St #220 (string) - Address of the business. + + health (array) - Aggregates sum and percentage metrics for distinct statuses + + + + Body + + { + "listingStatus": [{ + "sourceName": "Navmii", + "status": "Action Required", + "liveLink": "http://livepoi.navmii.com/p/view/4d6c-ace0-0a2483b47182", + "name": "Richard L. Blackhurst/Utah Dental Center", + "phone": "(123) 456-7890", + "address": "420 E S Temple St #220" + }, + { + "sourceName": "Where To?", + "status": "In Progress", + "liveLink": "https://wheretoapp.com/search?poi=86183685562887", + "name": "Richard L. Blackhurst/Utah Dental Center", + "phone": "(123) 456-0987", + "address": "420 E S Temple St #220" + }], + "health": [ { - "day": 1, - "isOpen": 1, - "workingHours": [ - { - "startHour": "09:00", - "endHour": "13:30" - }, - { - "startHour": "14:30", - "endHour": "19:00" - } - ] + "status": "Action Required", + "count": 1, + "percentage": 14.29 }, { - "day": 2, - "isOpen": 1, - "workingHours": [ - { - "startHour": "09:00", - "endHour": "13:30" - }, - { - "startHour": "14:30", - "endHour": "19:00" - } - ] + "status": "In Progress", + "count": 1, + "percentage": 14.29 }, { - "day": 3, - "isOpen": 1, - "workingHours": [ - { - "startHour": "09:00", - "endHour": "13:30" - }, - { - "startHour": "14:30", - "endHour": "19:00" - } - ] + "status": "Reconnect", + "count": 1, + "percentage": 14.29 }, { - "day": 4, - "isOpen": 1, - "workingHours": [ - { - "startHour": "09:00", - "endHour": "13:30" - }, - { - "startHour": "14:30", - "endHour": "19:00" - } - ] + "status": "Connect", + "count": 1, + "percentage": 14.29 }, { - "day": 5, - "isOpen": 1, - "workingHours": [ - { - "startHour": "09:00", - "endHour": "13:30" - }, - { - "startHour": "14:30", - "endHour": "19:00" - } - ] + "status": "Live", + "count": 1, + "percentage": 14.29 }, { - "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 + "status": "Opted out", + "count": 1, + "percentage": 14.29 }, { - "specialDate": "01/01/2021", - "startHour": "", - "endHour": "", - "isOpen": 1 + "status": "Sync Initiated", + "count": 1, + "percentage": 14.29 } - ], - "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", - "payment": "Visa,MasterCard,AmericanExpress,DebitCards,Check", - "localPhoneNumber": "(973)716-0102", - "tollFreePhoneNumber": "", - "iosAppURL": "http://www.gmail.com", - "androidAppURL": "http://www.gmail.com" - }, - "media": { - "logoUrl": "http://d2xt3xymj142xp.cloudfront.net/712586432/other/ab60b93831ba490383b9c59c0b4cf49d.jpeg", - "coverImageUrl": "http://d2xt3xymj142xp.cloudfront.net/712586432/other/ab60b93831ba490383b9c59c0b4cf49d.jpeg", - "gmbCover": "http://d3cnqzq0ivprch.cloudfront.net/common/css/images/profile/abcd.jpg", - "facebookCover": "http://d3cnqzq0ivprch.cloudfront.net/common/css/images/profile/fb.jpg" - }, - "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" + ] + } + ++ Response 401 + + [1161][] + ++ Response 429 + + [89][] + ++ Response 401 + + [1167][] + ++ Response 404 + + [1175][] + + +## Listings Insights [/v1/listing/insights{?api_key,businessId}] +Insights/Analytics for Google Listings of a given business. + +### Listings Insights [POST] + ++ Parameters - }, - "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": "Storage facility", - "googleDescription": "This is sample description for google", - "additionalCategories": [ - "Snack bar" - ], - "attributes": { - "Accessibility": [ - { - "attributeId": "has_wheelchair_accessible_elevator", - "attributeName": "Wheelchair accessible elevator", - "value": false - } - ], - "Crowd": [ + + api_key: abcdefgh (string, required) - Partner specific API key provided by Birdeye for data exchange. + + businessId: 12345678 (number, required) - Id of the account. + ++ Request (application/json) + + + Headers + + Accept: application/json + + + + 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"] + } + + + ++ 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. + + 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. + + websiteVisitsTotalCount: 2868 (number) - The number of times the business profile website was clicked. + + getDirectionsTotalCount: 0 (number) - The number of times a direction request was requested to the business location. + + callsTotalCount: 2868 (number) - The number of times the business profile call button was clicked. + + usersReachedTotalCount: 0 (number) - The number of times your business appeared in search results and other services in Bing. + + impressionCountTotalCount: 0 (number) - The number of users who saw the activity from your page including posts, check-ins, and ads. + + liveCount: 10 (number) - Total no of synched sites for a business. + + entityCount: 1 (number) - Total businesses count. + + viewMode (array) - is data required for mobile or desktop or both (if none is provided then data for both will be displayed) + + + Body + + { + "mapViewTotalCount": 2868, + "searchViewTotalCount": 2868, + "websiteVisitsTotalCount": 2868, + "getDirectionsTotalCount": 0, + "callsTotalCount": 2868, + "usersReachedTotalCount": 0, + "impressionCountTotalCount": 0, + "liveCount": 10, + "entityCount": 1 + } + + ++ Response 401 + + [1161][] + ++ Response 429 + + [89][] + ++ Response 401 + + [1167][] + ++ Response 404 + + [1175][] + + + +## Listings Insights Datapoints [/v1/listing/report/{reportType}/datapoints{?api_key,businessId}] +Datapoints of report graph is date/label mapped to value/data of a given business. + +### Listings Insights Datapoints [POST] + ++ Parameters + + + api_key: abcdefgh (string, required) - Partner specific API key provided by Birdeye for data exchange. + + 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 + + + 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"] + } + + + ++ 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: 12345678 (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 + 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" + }, { - "attributeId": "welcomes_families", - "attributeName": "Family-friendly", - "value": true + "value": "false", + "displayName": "No wheelchair accessible restroom" } ] }, - "foodDelivery":"https://www.ubereats.com", - "foodTakeout":"https://www.ubereats.com" - }, - "appleListing": { - "primaryCategory": "active.amateursportsteams", - "additionalCategories": [ - "active.publicplazas", - "auto.autoelectric", - "auto.autoelectric" - ], - "appleLocationAttributes": { - "crossbusiness.accessibility_features": [{ - "attributeId": "accessible_elevator" - } - ], - "crossbusiness.family_kids": [{ - "attributeId": "kidsclub" - },{ - "attributeId": "parents_waitingarea" - } - ] - }, - "appleActionLinks": [{ - "id": "quicklinks.airline_book_travel", - "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": "", - "lendingtreeUrl": "" - }, - "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" - }, + { + "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][] @@ -13933,10 +12496,25 @@ The Get Listing API will get the listing information for the given business numb [89][] -## Get More Hours Type [/v1/listing/{businessNumber}/more-hours-type] -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] ++ Response 400 + + [4011][] + ++ Response 400 + + [4012][] + ++ Response 400 + + [4013][] + + +## 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 @@ -13953,27 +12531,117 @@ Get supported more hours type for a location. This will depend on the country an + Response 200 - + Attributes (array) - + (object) + + Attributes + + Accessibility (array) - This is dynamic field. Depends upon request inputs. + + (object) + Body - [ - "Access", - "Breakfast", - "Brunch", - "Delivery", - "Dinner", - "Drive through", - "Happy hours", - "Kitchen", - "Lunch", - "Online service hours", - "Pickup", - "Takeout", - "Senior hours" - ] + { + "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: 12345678 (number, required) - Business Number. + ++ Request (application/json) + + + + Headers + + Accept: application/json + 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" + } + + ] @@ -13988,7 +12656,7 @@ Get supported more hours type for a location. This will depend on the country an + Response 400 - [4014][] + [4011][] + Response 400 @@ -13998,99 +12666,63 @@ Get supported more hours type for a location. This will depend on the country an [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 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 Google Keywords Count [POST] +### Get Category List [GET] + Parameters - + businessNumber: 986031488 (string, required) - Account Business Number. - + + businessNumber: 12345678 (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 - api_key: - Partner specific API key provided by Birdeye for data exchange. + api_key: [Required] 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. ++ Response 200 - + Body + + 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” - { - "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 + + 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 + } + ] - + 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 @@ -14100,29 +12732,29 @@ Google keyword: Top keywords searched for which your business is ranked. [89][] -+ Response 404 - [1011][] ++ Response 400 -+ Response 401 + [4014][] - [1167][] ++ Response 400 + + [4012][] + Response 400 - [2457][] + [4013][] + Response 400 - [2458][] + [4015][] -## 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. +## 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. -### Deactivate Listing [POST] + +### Create Listing [POST] + Parameters @@ -14137,137 +12769,598 @@ Deactivate Listing API stops publishing any information on the given online dire api_key: [Required] Partner specific API key provided by Birdeye for data exchange. -+ Response 200 (application/json) - -+ Response 401 - - [1161][] - -+ Response 429 - - [89][] - -## Create Question [/v1/qna/question/create{?api_key,businessId}] -Create new Question on Google Q&A section of your business - - -### Create Question [POST] - -+ Parameters - + businessId: 12345678 (string, required) - Id of the business. - + api_key: abcdefgh (string, required) - Partner specific API key provided by Birdeye for data exchange. - -+ Request (application/json) - - + Headers - - Accept: application/json - 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 - + answer: Enter answer here (string,required) - text of the answer to be posted on Google Q&A profile ; minimum 1 one non-space character - - - + Body - - { - "question": "Enter question here", - "answer": "Enter answer here" - } - - -+ Response 200 (application/json) + + Attributes + + businessInfo - Business Information + + name: Drs. Chalker and Peterson, A Dental Partnership (required, 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. + + 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. + + 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. + + 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. + + 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) - It will update your business status on lisitng page and If business will choose "Temporarily closed" then Reopen date is mandatry. [Open, Temporarily closed, Permanently closed] + + reopenDate : 10/20/2022 - Reopen date is applicable only when the status is "temporarily closed". It should be "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 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. + + 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. + + categories (string) - 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. + + 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) - 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 + + category (string) - 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. + + additionalCategory (string) - You can add up to 5 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 + + 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. + + 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. + + 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 - + 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{?api_key,businessId}] -Add Answer to Existing Question. Owner can add only one answer per question - - - -### Create Answer [POST] - -+ Parameters - + businessId: 12345678 (string, required) - Id of the business. - + api_key: abcdefgh (string, required) - Partner specific API key provided by Birdeye for data exchange. - - -+ Request (application/json) - - + Headers - - Accept: application/json - 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 - + "businessInfo": { + "name": "Dieci Lifestyle Spa", + "phone": "(973) 716-0007", + "websiteUrl": "http://www.diecispa.org/", + "emailId": "example@birdeye.com", + "isAddressHidden": "No", + "isServiceAreaProvider": "No", + "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. & 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" + } + ] + } + ] + }, + "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", + "payment": "Visa,MasterCard,AmericanExpress,DebitCards,Check", + "localPhoneNumber": "(973)716-0102", + "tollFreePhoneNumber": "", + "iosAppURL": "http://www.gmail.com", + "androidAppURL": "http://www.gmail.com" + }, + "media": { + "logoUrl": "http://d2xt3xymj142xp.cloudfront.net/712586432/other/ab60b93831ba490383b9c59c0b4cf49d.jpeg", + "coverImageUrl": "http://d2xt3xymj142xp.cloudfront.net/712586432/other/ab60b93831ba490383b9c59c0b4cf49d.jpeg", + "gmbCover": "http://d3cnqzq0ivprch.cloudfront.net/common/css/images/profile/abcd.jpg", + "facebookCover": "http://d3cnqzq0ivprch.cloudfront.net/common/css/images/profile/fb.jpg" - + Body + }, + "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" - { - "questionId": 7812, - "answer": "Enter answer here" + }, + "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": "Storage facility", + "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" + }, + "appleListing": { + "primaryCategory": "active.amateursportsteams", + "additionalCategories": [ + "active.publicplazas", + "auto.autoelectric", + "auto.autoelectric" + ], + "appleLocationAttributes": { + "crossbusiness.accessibility_features": [{ + "attributeId": "accessible_elevator" + } + ], + "crossbusiness.family_kids": [{ + "attributeId": "kidsclub" + },{ + "attributeId": "parents_waitingarea" + } + ] + }, + "appleActionLinks": [{ + "id": "quicklinks.airline_book_travel", + "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": "", + "lendingtreeUrl": "" + }, + "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) - - - + Attributes - + answer_id: 2893 (string) - unique answer identifier - - + Body - { - "answer_id":2893 - } ++ Response 200 (application/json) + Response 401 @@ -14277,161 +13370,628 @@ Add Answer to Existing Question. Owner can add only one answer per question [89][] -+ Response 404 - - [1011][] - -+ Response 401 - - [1167][] - -+ Response 401 - - [2478][] - -+ Response 401 - - [2479][] - -+ Response 401 - - [2481][] - -+ Response 401 - - [2485][] - -+ Response 401 - - [2483][] -+ Response 401 ++ Response 400 - [2461][] - -+ Response 401 + [2296][] - [2462][] ++ Response 400 + [2297][] ++ Response 400 -## Update Question [/v1/qna/question/update{?api_key,businessId}] -Update an existing question + [2290][] +## Update Listing [/v1/listing/{businessNumber}/update] +The Update Listing API will update the location details on all your listings sites. -### Update Question [PUT] +### Update Listing [PUT] + Parameters - + businessId: 12345678 (string, required) - Id of the business. - + api_key: abcdefgh (string, required) - Partner specific API key provided by Birdeye for data exchange. + + businessNumber: 12345678 (number, required) - Business Number. + Request (application/json) + + Headers Accept: application/json - api_key: - Partner specific API key provided by Birdeye for data exchange. + api_key: [Required] 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 + + + Attributes + + businessInfo - Business Information + + name: Drs. Chalker and Peterson, A Dental Partnership (required, 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. + + 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. + + 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. + + 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. + + 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) - It will update your business status on lisitng page and If business will choose "Temporarily closed" then Reopen date is mandatry. [Open, Temporarily closed, Permanently closed] + + reopenDate : 10/20/2022 - Reopen date is applicable only when the status is "temporarily closed". It should be "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 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. + + 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. + + categories (string) - 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. + + 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) - 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 + + category (string) - 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. + + additionalCategory (string) - You can add up to 5 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 + + 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. + + 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. + + 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 { - "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{?api_key,businessId}] -Update an answer to an existing question - - - -### Update Answer [PUT] - - -+ Parameters - + businessId: 12345678 (string, required) - Id of the business. - + api_key: abcdefgh (string, required) - Partner specific API key provided by Birdeye for data exchange. - - -+ Request (application/json) - - + Headers - - Accept: application/json - 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 - - - + Body + "businessInfo": { + "name": "Dieci Lifestyle Spa", + "phone": "(973) 716-0007", + "websiteUrl": "http://www.diecispa.org/", + "emailId": "example@birdeye.com", + "isAddressHidden": "No", + "isServiceAreaProvider": "No", + "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. & 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" + } + ] + } + ] + }, + "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", + "payment": "Visa,MasterCard,AmericanExpress,DebitCards,Check", + "localPhoneNumber": "(973)716-0102", + "tollFreePhoneNumber": "", + "iosAppURL": "http://www.gmail.com", + "androidAppURL": "http://www.gmail.com" + }, + "media": { + "logoUrl": "http://d2xt3xymj142xp.cloudfront.net/712586432/other/ab60b93831ba490383b9c59c0b4cf49d.jpeg", + "coverImageUrl": "http://d2xt3xymj142xp.cloudfront.net/712586432/other/ab60b93831ba490383b9c59c0b4cf49d.jpeg", + "gmbCover": "http://d3cnqzq0ivprch.cloudfront.net/common/css/images/profile/abcd.jpg", + "facebookCover": "http://d3cnqzq0ivprch.cloudfront.net/common/css/images/profile/fb.jpg" + }, + "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" - { - "questionId": 7812, - "answerId": 7813, - "question": "Enter answer here" + }, + "internalListing": { + "description": "Alok 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 Alok 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": "Storage facility", + "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" + }, + "appleListing": { + "primaryCategory": "active.amateursportsteams", + "additionalCategories": [ + "active.publicplazas", + "auto.autoelectric", + "auto.autoelectric" + ], + "appleLocationAttributes": { + "crossbusiness.accessibility_features": [{ + "attributeId": "accessible_elevator" + } + ], + "crossbusiness.family_kids": [{ + "attributeId": "kidsclub" + },{ + "attributeId": "parents_waitingarea" + } + ] + }, + "appleActionLinks": [{ + "id": "quicklinks.airline_book_travel", + "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": "", + "lendingtreeUrl": "" + }, + "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 @@ -14442,243 +14002,683 @@ Update an answer to an existing question [89][] -+ Response 404 - - [1011][] - -+ Response 401 - - [1167][] - -+ Response 401 - - [2478][] - -+ Response 401 - - [2479][] - -+ Response 401 - - [2481][] - -+ Response 401 ++ Response 400 - [2485][] - -+ Response 401 + [2296][] - [2483][] -+ Response 401 ++ Response 400 - [2461][] - -+ Response 401 + [2297][] - [2480][] -+ Response 401 ++ Response 400 - [2482][] - + [2290][] -## Delete Question [/v1/qna/question/delete{?api_key,businessId}] -Delete existing questions. Only that question can be deleted which is posted by the owner. +## Get Listing [/v1/listing/{businessNumber}/get] +The Get Listing API will get the listing information for the given business number/ ID. -### Delete Question [POST] +### Get Listing [GET] + Parameters - + businessId: 12345678 (string, required) - Id of the business. - + api_key: abcdefgh (string, required) - Partner specific API key provided by Birdeye for data exchange. + + businessNumber: 12345678 (number, required) - Business Number. + Request (application/json) + + Headers Accept: application/json - api_key: - Partner specific API key provided by Birdeye for data exchange. - - + Attributes - + questionId: 7812 (number , required ) - unique question identifier - - - + Body - - { - "questionId": 7812 - - } + api_key: [Required] Partner specific API key provided by Birdeye for data exchange. + 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{?api_key,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. - + api_key: abcdefgh (string, required) - Partner specific API key provided by Birdeye for data exchange. - - -+ Request (application/json) - - + Headers - - Accept: application/json - 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 - + + 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. + + 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. + + 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) - It will update your business status on lisitng page and If business will choose "Temporarily closed" then Reopen date is mandatry. [Open, Temporarily closed, Permanently closed] + + reopenDate : 10/20/2022 - Reopen date is applicable only when the status is "temporarily closed". It should be "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 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 (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. + + categories (string) - 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. + + 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) - 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 + + category (string) - 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. + + additionalCategory (string) - You can add up to 5 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 + + 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. + + 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. + + 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 { - "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 + "businessInfo": { + "name": "Dieci Lifestyle Spa", + "phone": "(973) 716-0007", + "websiteUrl": "http://www.diecispa.org/", + "emailId": "example@birdeye.com", + "isAddressHidden": "No", + "isServiceAreaProvider": "No", + "serviceAreas": [ + { + "description": "Van An, Berryessa Road, San Jose, CA, USA", + "placeId": "ChIJc_clvUTMj4AR_K0M2GO2CYg" + }, + { + "description": "Santa Clara, CA, USA", + "placeId": "ChIJk8EIXIG3j4ARwL_Ao3ykdeQ" + } + ], + "location": { + "address1": "90 W Mount Pleasant Ave", + "address2": "(btwn Preston Dr. & 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" + } + ] + } + ] + }, + "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", + "payment": "Visa,MasterCard,AmericanExpress,DebitCards,Check", + "localPhoneNumber": "(973)716-0102", + "tollFreePhoneNumber": "", + "iosAppURL": "http://www.gmail.com", + "androidAppURL": "http://www.gmail.com" + }, + "media": { + "logoUrl": "http://d2xt3xymj142xp.cloudfront.net/712586432/other/ab60b93831ba490383b9c59c0b4cf49d.jpeg", + "coverImageUrl": "http://d2xt3xymj142xp.cloudfront.net/712586432/other/ab60b93831ba490383b9c59c0b4cf49d.jpeg", + "gmbCover": "http://d3cnqzq0ivprch.cloudfront.net/common/css/images/profile/abcd.jpg", + "facebookCover": "http://d3cnqzq0ivprch.cloudfront.net/common/css/images/profile/fb.jpg" + }, + "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" - [2483][] -+ Response 401 + }, + "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": "Storage facility", + "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" + }, + "appleListing": { + "primaryCategory": "active.amateursportsteams", + "additionalCategories": [ + "active.publicplazas", + "auto.autoelectric", + "auto.autoelectric" + ], + "appleLocationAttributes": { + "crossbusiness.accessibility_features": [{ + "attributeId": "accessible_elevator" + } + ], + "crossbusiness.family_kids": [{ + "attributeId": "kidsclub" + },{ + "attributeId": "parents_waitingarea" + } + ] + }, + "appleActionLinks": [{ + "id": "quicklinks.airline_book_travel", + "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": "", + "lendingtreeUrl": "" + }, + "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" + }, + } - [2461][] - -+ Response 401 - [2480][] + Response 401 - [2482][] - + [1161][] -## Delete All Questions and Answers [/v1/qna/question/deleteAll{?api_key,businessId}] -Delete all A&A on the businessId provided. ++ Response 429 + [89][] +## Get More Hours Type [/v1/listing/{businessNumber}/more-hours-type] +Get supported more hours type for a location. This will depend on the country and gmb primary category for the particular location. -### Delete All Questions and Answers [DELETE] +### Get More Hours Type [GET] + Parameters - + businessId: 12345678 (string, required) - Id of the business. - + api_key: abcdefgh (string, required) - Partner specific API key provided by Birdeye for data exchange. + + businessNumber: 12345678 (number, required) - Business Number. + Request (application/json) + + Headers Accept: application/json - api_key: - Partner specific API key provided by Birdeye for data exchange. + api_key: [Required] 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 - ++ Response 200 + + + Attributes (array) + + (object) + Body - { - "questionId": 7812, - "answerId":7813 - - } + [ + "Access", + "Breakfast", + "Brunch", + "Delivery", + "Dinner", + "Drive through", + "Happy hours", + "Kitchen", + "Lunch", + "Online service hours", + "Pickup", + "Takeout", + "Senior hours" + ] + -+ Response 200 (application/json) + Response 401 @@ -14688,53 +14688,34 @@ Delete all A&A on the businessId provided. [89][] -+ Response 404 - - [1011][] - -+ Response 401 - [1167][] ++ Response 400 -+ Response 401 + [4014][] - [2478][] - -+ Response 401 ++ Response 400 - [2479][] - -+ Response 401 + [4012][] - [2481][] - -+ Response 401 ++ Response 400 - [2485][] - -+ Response 401 + [4013][] - [2483][] -+ Response 401 ++ Response 400 - [2461][] - -+ Response 401 + [4015][] - [2480][] -+ Response 401 +## 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. - [2482][] +### Get Google Keywords Count [POST] -## Get All Questions and Answers [/v1/qna/get{?api_key,businessId}] -Get all Questions and Answers for a Business ++ Parameters -### Get All Questions and Answers [POST] + + businessNumber: 986031488 (string, required) - Account Business Number. -+ Parameters - + businessId: 12345678 (string, required) - Id of the business. - + api_key: abcdefgh (string, required) - Partner specific API key provided by Birdeye for data exchange. + Request (application/json) @@ -14744,80 +14725,76 @@ Get all Questions and Answers for a Business api_key: - Partner specific API key provided by Birdeye for data exchange. + Attributes - + startIndex: 25 (number , required ) - start index - + pageSize: 25 (number,required) - page size + + 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, - "pageSize":25 + "selectedkeywords": [ + "prom" + ], + "sortby": "frequency", + "order": "desc", + "keywordsSearch": "prom dresses" } -+ Response 200 (application/json) - ++ Response 200 + Attributes - - + totalCount: 100 (number) - Total number of questions - + questionsAndAnswers (array) - Questions and answers details + + data (array) - Returns business/location name along with its keywords count. + (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 h:mm a - + updatedOn: Apr 10, 2024 (string) - Date at which question was created/updated MMM d, 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 d, yyyy - + time: 10:52 PM (string) - time at which answer was created/updated format: h:mm a - + userCategory: MERCHANT (string) - category of author MERCHANT, REGULAR_USER, LOCAL_GUIDE - + userProfileLogoUrl: http://logourl (string) - url link to google profile photo of author - - + + label: Total (string) - Business/location name. Total, for sum of all locations keyword count + + frequency: 50909 (string) - Keywords count + + Body + { - "totalCount": 1, - "questionsAndAnswers": [ + "data": [ { - "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" - } - ] + "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][] @@ -14834,9 +14811,45 @@ Get all Questions and Answers for a Business [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: 12345678 (number, required) - Business Number. + ++ Request (application/json) + + + + Headers + + Accept: application/json + api_key: [Required] Partner specific API key provided by Birdeye for data exchange. + + ++ Response 200 (application/json) + + Response 401 - [2466][] + [1161][] + ++ Response 429 + + [89][] + # Group Ticketing From f5b8a326cf7e689a27ef67c304fc2d59e9708601 Mon Sep 17 00:00:00 2001 From: ishanRathi Date: Wed, 29 May 2024 10:12:00 +0530 Subject: [PATCH 4/4] Changes for developer document --- apiary.apib | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/apiary.apib b/apiary.apib index 8366103..b1196f4 100644 --- a/apiary.apib +++ b/apiary.apib @@ -11374,8 +11374,8 @@ Create a new question and associated answer 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 - + answer: Enter answer here (string,required) - text of the answer to be posted on Google Q&A profile ; minimum 1 one non-space character + + 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 @@ -11457,7 +11457,7 @@ This API would be needed when you wish to answer a third party raised question. + 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 + + 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 @@ -11547,7 +11547,7 @@ Update an existing question. You can edit/ update an existing question posted / + 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 + + 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 @@ -11631,7 +11631,7 @@ Update an answer to an existing question. You can edit/ update an existing answe + 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 + + 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 @@ -11858,7 +11858,7 @@ Delete answers to existing questions. Only that answer can be deleted which is p ## Delete All Questions and Answers [/v1/qna/question/deleteAll{?api_key,businessId}] -Delete all A&A on the businessId provided. +Delete all Q&A on the businessId provided.