Birdeye
App · 13 actions
Read Birdeye businesses and reviews and manage contacts.
Actions
| Action | What it does |
|---|---|
| Delete contact | Delete contact. |
| Get business | Get business. |
| Get contact | Get contact. |
| Get review summary | Get review summary. |
| List child businesses | List child businesses. |
| List contact activity | List contact activity. |
| List contacts | List contacts. |
| List opted out contacts | List opted out contacts. |
| List review tags | List review tags. |
| List reviews | List reviews. |
| List time zones | List time zones. |
| Save contact | Save contact. |
| Search businesses | Search businesses. |
Delete contact
Delete contact.
Inputs
- Business Id
businessIdtext - Businessid.
- Id
idtextRequired - Id of enterprise customer.
- Business Ids
businessIdslist - List of business Ids. If businessIds are provided, mappings would be deleted from those locations only. If no businessIds are provided, the customer would be deleted from all the locations.
Outputs
dataobject- Response.
Example output
{
"data": {}
}Get business
Get business.
Inputs
- Business Id
business_idtext - Business id.
Outputs
dataobject- Response.
Example output
{
"data": {
"alias": "example",
"avgRating": 1.0,
"businessId": 1.0,
"category": "example",
"coverImageUrl": "example",
"description": "example",
"emailId": "example",
"facebookCover": "example",
"fax": "example",
"gmbCover": "example",
"hoursOfOperations": [],
"isSEOEnabled": false,
"isServiceAreaProvider": "example",
"keywords": "example",
"languages": [],
"location": {
"address1": "example",
"address2": "example",
"city": "example",
"countryCode": "example",
"state": "example",
"subLocality": "example",
"zip": "example"
},
"logoUrl": "example",
"name": "example",
"payment": "example",
"phone": "example",
"reviewCount": 1.0,
"serviceAreas": [],
"services": "example",
"socialProfileURLs": {
"facebookUrl": "example",
"googleUrl": "example",
"linkedInUrl": "example",
"twitterUrl": "example",
"youTubeUrl": "example"
},
"status": "example",
"timezone": "example",
"type": "example",
"websiteUrl": "example",
"working24x7": 1.0
}
}Get contact
Get contact.
Inputs
- Business Id
businessIdtext - Businessid.
- Id
idtext - Id of enterprise customer. optional (if cid, phone or email is provided).
- Cid
cidtext - Id of customer mapping on a location. optional (if id, phone or email is provided).
- Email
emailtext - Email of customer, optional (if phone, id or cid is provided).
- Phone
phonetext - Phone of customer optional (if email, id or cid is provided).
- Experiencescore
experienceScoretrue/false - If true, includes the experience score of the customer in the response. Default is false.
Outputs
dataobject- Response.
Example output
{
"data": {
"countryCode": "example",
"customFields": [],
"email": "example",
"experienceScore": 1.0,
"experienceScoreSource": "example",
"externalId": "example",
"firstName": "example",
"id": "example",
"lastName": "example",
"mappings": [],
"phone": "example",
"smsOptin": false,
"tags": "example"
}
}Get review summary
Get review summary.
Inputs
- Business Id
businessIdtext - Businessid.
- Statuses
statuseslist - Statuses.
Outputs
dataobject- Response.
Example output
{
"data": {
"ratings": [],
"sources": []
}
}List child businesses
List child businesses.
Inputs
- Pid
pidtext - Pid.
Outputs
datalist- Response.
Example output
{
"data": []
}List contact activity
List contact activity.
Inputs
- Business Id
businessIdtext - Businessid.
- Startdate
startDatetext - Startdate.
- Enddate
endDatetext - Enddate.
- Customer Id
customerIdtextRequired - Customerid.
Outputs
datalist- Response.
Example output
{
"data": []
}List contacts
List contacts.
Inputs
- Tags
tagstrue/false - Tags.
- Customfields
customfieldstrue/false - Customfields.
- Sources
sourceslist - Source of the customer/lead. Possible values are api,dashboard,facebook,integration,sftp,bulkupload,webchat,crmimport,other,referral,voicecall,text,email,google.
- Startdateutc
startDateUtcdate and timeRequired - Startdateutc.
- Enddateutc
endDateUtcdate and timeRequired - Enddateutc.
- Contacttype
contactTypetext - Possible values are "lead", "customer". If blank then all contact types are returned.
- Business Id
businessIdtext - Businessid.
- Page
pagetextRequired - Page number to request.
- Size
sizetextRequired - Number of records per page, max is 5000.
Outputs
dataobject- Response.
Example output
{
"data": {
"contacts": [],
"page": 1.0,
"size": 1.0,
"totalPages": 1.0
}
}List opted out contacts
List opted out contacts.
Inputs
- Business Id
businessIdtext - Businessid.
- Items
itemstextRequired - Items.
Outputs
dataobject- Response.
Example output
{
"data": {
"blocked": [],
"emailOptOut": [],
"textOptOut": []
}
}List review tags
List review tags.
Inputs
- Business Id
businessIdtext - Businessid.
Outputs
datalist- Response.
Example output
{
"data": []
}List reviews
List reviews.
Inputs
- Business Id
businessIdtext - Businessid.
- Sindex
sindexnumberRequired - Sindex.
- Count
countnumberRequired - Count.
- Includenonaggregatedreviews
includeNonAggregatedReviewstrue/false - Includenonaggregatedreviews.
- Fromdate
fromDatedate - Review date start in UTC format.
- Todate
toDatedate - Review date end in UTC format, eg if toDate is 04/01/2013, reviews of date 04/01/2013 is excluded .
- Fromtimestamp
fromTimestampdate and time - Fromtimestamp.
- Totimestamp
toTimestampdate and time - Totimestamp.
- Updatefromdate
updateFromDatedate - Review updated date start in UTC format.
- Updatetodate
updateToDatedate - Review updated date end in UTC format.
- Sources
sourcestext - Aggregation source name Note: use "our_website" to filter reviews posted on Birdeye platform or use "direct_feedback" for direct feedback.
- Ratings
ratingslist - Review rating Possible values 0,1,2,3,4,5.
- Searchstr
searchStrtext - String that is contained by review.
- Subbusiness Ids
subBusinessIdslist - BusinessIds under enterprise account.
- Statuses
statuseslist - Review status filter. Valid values are "published", "parked", and "all". If omitted, default is "published" only (featured reviews). "published" refers to featured reviews and "parked" refers to non-featured reviews.
- Allchild
allChildtrue/false - Get review from all child ignoring merge reviews flag configured at parent/child relationship level.
- Tags
tagslist - Reviews with assigned tags
- Fetchextraparams
fetchExtraParamstrue/false - To fetch custom field(s) associated with the customer attributed to the review [if any].
- Needcustomerinfo
needCustomerInfotrue/false - To fetch customer information associated with the reviewer [if attributed].
- Fetchassitedbydetails
fetchAssitedByDetailstrue/false - To retrieve employees associated with the review [if mapped].
- Messageoptions Reviewfilteroptions
messageOptions_reviewFilterOptionslist - Filter reviews by operational status. Accepted values: `"Updated-Reviews"` (reviews that have been updated after being posted) and `"Non-Updated-Reviews"` (reviews that have never been updated). Values are case-insensitive. If both values are provided together, no filter is applied.One or more of:
Updated-Reviews,Non-Updated-Reviews.
Outputs
datalist- Response.
Example output
{
"data": []
}List time zones
List time zones.
Inputs
- Businessnumber
businessNumbertext - Businessnumber.
Outputs
dataobject- Response.
Example output
{
"data": {
"timezones": []
}
}Save contact
Save contact.
Inputs
- Business Id
businessIdtext - Businessid.
- Id
idtext - Id of enterprise customer.
- Firstname
firstNametext - First name of the customer.
- Lastname
lastNametext - Last name of the customer.
- Email
emailtext - Email of customer, optional (if phone is provided).
- Phone
phonetext - Phone of customer optional (if email is provided).
- Countrycode
countryCodetext - Country code of the phone number. Default value=US, Other Possible values=AU,CA,MX,PR,VI
- Smsoptin
smsOptintrue/false - SMS Opt flag.
- Emailoptin
emailOptintrue/false - Email Opt flag.
- Blocked
blockedtrue/false - Contact block flag.
- Business Ids
businessIdslist - Business Ids under enterprise account. The Business Ids field is mandatory while creating a new contact. While updating, if no business Ids are provided, the same location mappings are retained.
- Tags
tagstext - List of tags.
- Customfields
customFieldslist - List of Custom fields. We currently support 4 types of customfields - text, number, currency, date (in formats - “MM/dd/yyyy” and "MM-dd-yyyy" only), and yes or no (1:"yes", 0:"no").
- External Id
externalIdtext - Unique external identifier of the contact which could be from the CRM or any external system storing your contacts.
Outputs
dataobject- Response.
Example output
{
"data": {
"id": 1.0
}
}Search businesses
Search businesses.
Inputs
- Businessnumber
businessNumbertext - Businessnumber.
- Searchstr
searchStrtext - Search criteria for business. This could be business name or number.
- Sortby
sortBytext - Results can be sorted by name, createdAt, and createdBy. By default is createdAt.
- Sortorder
sortOrdertext - The SORT order, Possible values "ASC" or "DESC". By default is "DESC".
- Startindex
startIndexnumber - Once sorted, it defines starting from which index a page (number of specified search results) is to be created.
- Pagesize
pageSizenumber - Determines the number of search results in the response. Users can set a desired value to limit results, e.g., pageSize=25 shows the top 25 business listings. The Default value is 25.
Outputs
dataobject- Response.
Example output
{
"data": {
"accounts": [],
"totalCount": 1.0
}
}