# Birdeye

> Read Birdeye businesses and reviews and manage contacts.

App · 13 actions. Web page: https://docs.lodol.com/docs/integrations/birdeye

## Actions

### Delete contact

Delete contact.

**Inputs**

- Business Id (`businessId`, text): Businessid.
- Id (`id`, text, required): Id of enterprise customer.
- Business Ids (`businessIds`, list): 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**

- `data` (object): Response.

**Example output**

```json
{
  "data": {}
}
```

### Get business

Get business.

**Inputs**

- Business Id (`business_id`, text): Business id.

**Outputs**

- `data` (object): Response.

**Example output**

```json
{
  "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 (`businessId`, text): Businessid.
- Id (`id`, text): Id of enterprise customer. optional (if cid, phone or email is provided).
- Cid (`cid`, text): Id of customer mapping on a location. optional (if id, phone or email is provided).
- Email (`email`, text): Email of customer, optional (if phone, id or cid is provided).
- Phone (`phone`, text): Phone of customer optional (if email, id or cid is provided).
- Experiencescore (`experienceScore`, true/false): If true, includes the experience score of the customer in the response. Default is false.

**Outputs**

- `data` (object): Response.

**Example output**

```json
{
  "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 (`businessId`, text): Businessid.
- Statuses (`statuses`, list): Statuses.

**Outputs**

- `data` (object): Response.

**Example output**

```json
{
  "data": {
    "ratings": [],
    "sources": []
  }
}
```

### List child businesses

List child businesses.

**Inputs**

- Pid (`pid`, text): Pid.

**Outputs**

- `data` (list): Response.

**Example output**

```json
{
  "data": []
}
```

### List contact activity

List contact activity.

**Inputs**

- Business Id (`businessId`, text): Businessid.
- Startdate (`startDate`, text): Startdate.
- Enddate (`endDate`, text): Enddate.
- Customer Id (`customerId`, text, required): Customerid.

**Outputs**

- `data` (list): Response.

**Example output**

```json
{
  "data": []
}
```

### List contacts

List contacts.

**Inputs**

- Tags (`tags`, true/false): Tags.
- Customfields (`customfields`, true/false): Customfields.
- Sources (`sources`, list): Source of the customer/lead. Possible values are api,dashboard,facebook,integration,sftp,bulkupload,webchat,crmimport,other,referral,voicecall,text,email,google.
- Startdateutc (`startDateUtc`, date and time, required): Startdateutc.
- Enddateutc (`endDateUtc`, date and time, required): Enddateutc.
- Contacttype (`contactType`, text): Possible values are "lead", "customer". If blank then all contact types are returned.
- Business Id (`businessId`, text): Businessid.
- Page (`page`, text, required): Page number to request.
- Size (`size`, text, required): Number of records per page, max is 5000.

**Outputs**

- `data` (object): Response.

**Example output**

```json
{
  "data": {
    "contacts": [],
    "page": 1.0,
    "size": 1.0,
    "totalPages": 1.0
  }
}
```

### List opted out contacts

List opted out contacts.

**Inputs**

- Business Id (`businessId`, text): Businessid.
- Items (`items`, text, required): Items.

**Outputs**

- `data` (object): Response.

**Example output**

```json
{
  "data": {
    "blocked": [],
    "emailOptOut": [],
    "textOptOut": []
  }
}
```

### List review tags

List review tags.

**Inputs**

- Business Id (`businessId`, text): Businessid.

**Outputs**

- `data` (list): Response.

**Example output**

```json
{
  "data": []
}
```

### List reviews

List reviews.

**Inputs**

- Business Id (`businessId`, text): Businessid.
- Sindex (`sindex`, number, required): Sindex.
- Count (`count`, number, required): Count.
- Includenonaggregatedreviews (`includeNonAggregatedReviews`, true/false): Includenonaggregatedreviews.
- Fromdate (`fromDate`, date): Review date start in UTC format.
- Todate (`toDate`, date): Review date end in UTC format, eg if toDate is 04/01/2013, reviews of date 04/01/2013 is excluded .
- Fromtimestamp (`fromTimestamp`, date and time): Fromtimestamp.
- Totimestamp (`toTimestamp`, date and time): Totimestamp.
- Updatefromdate (`updateFromDate`, date): Review updated date start in UTC format.
- Updatetodate (`updateToDate`, date): Review updated date end in UTC format.
- Sources (`sources`, text): Aggregation source name Note: use "our_website" to filter reviews posted on Birdeye platform or use "direct_feedback" for direct feedback.
- Ratings (`ratings`, list): Review rating Possible values 0,1,2,3,4,5.
- Searchstr (`searchStr`, text): String that is contained by review.
- Subbusiness Ids (`subBusinessIds`, list): BusinessIds under enterprise account.
- Statuses (`statuses`, list): 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 (`allChild`, true/false): Get review from all child ignoring merge reviews flag configured at parent/child relationship level.
- Tags (`tags`, list): Reviews with assigned tags
- Fetchextraparams (`fetchExtraParams`, true/false): To fetch custom field(s) associated with the customer attributed to the review [if any].
- Needcustomerinfo (`needCustomerInfo`, true/false): To fetch customer information associated with the reviewer [if attributed].
- Fetchassitedbydetails (`fetchAssitedByDetails`, true/false): To retrieve employees associated with the review [if mapped].
- Messageoptions Reviewfilteroptions (`messageOptions_reviewFilterOptions`, list): 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**

- `data` (list): Response.

**Example output**

```json
{
  "data": []
}
```

### List time zones

List time zones.

**Inputs**

- Businessnumber (`businessNumber`, text): Businessnumber.

**Outputs**

- `data` (object): Response.

**Example output**

```json
{
  "data": {
    "timezones": []
  }
}
```

### Save contact

Save contact.

**Inputs**

- Business Id (`businessId`, text): Businessid.
- Id (`id`, text): Id of enterprise customer.
- Firstname (`firstName`, text): First name of the customer.
- Lastname (`lastName`, text): Last name of the customer.
- Email (`email`, text): Email of customer, optional (if phone is provided).
- Phone (`phone`, text): Phone of customer optional (if email is provided).
- Countrycode (`countryCode`, text): Country code of the phone number. Default value=US, Other Possible values=AU,CA,MX,PR,VI
- Smsoptin (`smsOptin`, true/false): SMS Opt flag.
- Emailoptin (`emailOptin`, true/false): Email Opt flag.
- Blocked (`blocked`, true/false): Contact block flag.
- Business Ids (`businessIds`, list): 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 (`tags`, text): List of tags.
- Customfields (`customFields`, list): 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 (`externalId`, text): Unique external identifier of the contact which could be from the CRM or any external system storing your contacts.

**Outputs**

- `data` (object): Response.

**Example output**

```json
{
  "data": {
    "id": 1.0
  }
}
```

### Search businesses

Search businesses.

**Inputs**

- Businessnumber (`businessNumber`, text): Businessnumber.
- Searchstr (`searchStr`, text): Search criteria for business. This could be business name or number.
- Sortby (`sortBy`, text): Results can be sorted by name, createdAt, and createdBy. By default is createdAt.
- Sortorder (`sortOrder`, text): The SORT order, Possible values "ASC" or "DESC". By default is "DESC".
- Startindex (`startIndex`, number): Once sorted, it defines starting from which index a page (number of specified search results) is to be created.
- Pagesize (`pageSize`, number): Determines the number of search results in the response. Users can set a desired value to limit results, e.g., pageSize=25 shows the top 25 business listings. The Default value is 25.

**Outputs**

- `data` (object): Response.

**Example output**

```json
{
  "data": {
    "accounts": [],
    "totalCount": 1.0
  }
}
```
