# Follow Up Boss

> Manage real estate contacts, lead events, notes and tasks, with polling for new or updated records.

App · 20 actions. Web page: https://docs.lodol.com/docs/integrations/follow-up-boss

## Actions

### Create lead event

Create lead event.

**Inputs**

- Source (`source`, text): The name of the lead source.
- System (`system`, text): The name of the system used in providing leads.
- Type (`type`, text): The type of event. Currently one of `Registration`, `Inquiry`, `Seller Inquiry`, `Property Inquiry`, `General Inquiry`, `Viewed Property`, `Saved Property`, `Visited Website`, `Incoming Call`, `Unsubscribed`, `Property Search`, `Saved Property Search`, `Visited Open House` or `Viewed Page`. One of: `Registration`, `Inquiry`, `Seller Inquiry`, `Property Inquiry`, `General Inquiry`, `Viewed Property`, `Saved Property`, `Visited Website`, `Incoming Call`, `Unsubscribed`, and 4 more.
- Message (`message`, text): A message from the user about this inquiry.
- Description (`description`, text): Any additional information about this inquiry.
- Person (`person`, object): Information about the lead who triggered this event. Follow Up Boss will automatically de-duplicate people based on their phone number or email address.
- Property (`property`, object): Information about the property this event is related to.
- Property search (`property_search`, object): If this event was an inquiry you may have information about what the person was searching for, you can submit this information using this field.
- Campaign (`campaign`, object): The name of the source where the lead originated. (e.g., If the lead came to your site through an organic search on `www.google.com` the source is "Google".)
- Page title (`page_title`, text): This field is to be used with the `Viewed Page` event type and indicates the title of the page viewed. (e.g., "Contact Us")
- Page url (`page_url`, text): This field is to be used with the `Viewed Page` event type and indicates the url of the page viewed. (e.g., "http://www.samplerealestate.com/contact-us")
- Page referrer (`page_referrer`, text): This field is to be used with the `Viewed Page` event type and indicates the referrer url where the visitor came from. (e.g., "https://www.google.com") (Note: If `pageReferrer` is sent in, `pageUrl` should be set as well.)
- Page duration (`page_duration`, number): This field is to be used with the `Viewed Page` event type and indicates the duration of the visitor on the page viewed given in seconds.
- Occurred at (`occurred_at`, date): The date this event occurred. This is used to determine if the event is historical. Historical events will not trigger workflows upon creation. Any DateTime greater than 1 day will be considered historical.

**Outputs**

- `data` (object): Returned value.

**Example output**

```json
{
  "data": {
    "body": "example",
    "created": "example",
    "firstName": "example",
    "id": 1,
    "lastName": "example",
    "name": "example",
    "updated": "example"
  }
}
```

### Create note

Create note.

**Inputs**

- Person ID (`person_id`, number, required): The ID of a person.
- Subject (`subject`, text): Gives a note a title or subject.
- Body (`body`, text, required): The content of the note.
- Is html (`is_html`, true/false): If enabled, will render the HTML tags contained within the body on the Follow Up Boss user interface.

**Outputs**

- `data` (object): Returned value.

**Example output**

```json
{
  "data": {
    "body": "example",
    "created": "example",
    "firstName": "example",
    "id": 1,
    "lastName": "example",
    "name": "example",
    "updated": "example"
  }
}
```

### Create person

Create person.

**Inputs**

- Deduplicate (`deduplicate`, true/false): Deduplicate. Default: `false`.
- Created at (`created_at`, date and time): Will set the creation time for the person, if wanting to create historical leads.
- First name (`first_name`, text): The first/given name of the person.
- Last name (`last_name`, text): The last/family name of the person.
- Stage (`stage`, text): The stage the person is in. (e.g., "Lead" or "Trash". See [stage API endpoint](ref:stages-get) for more options.). Default: `Lead`.
- Source (`source`, text): The source of the lead.
- Source url (`source_url`, text): This is a direct link to the information about a person at the lead provider.
- Contacted (`contacted`, true/false): Whether the person has been contacted or not.
- Price (`price`, number): The price of the property of the person's first inquiry, or the estimated sell/buy price for this person.
- Assigned user (`assigned_user_id`, number): ID of the agent assigned to this person.
- Assigned pond ID (`assigned_pond_id`, number): ID of the pond assigned to this person.
- Assigned lender name (`assigned_lender_name`, text): Full name of the lender assigned to this person.
- Assigned lender ID (`assigned_lender_id`, number): ID of the lender assigned to this person.
- Emails (`emails`, list): A list of email addresses associated with the person. (Specify type and value, isPrimary is not expected. The first email in the list will be the primary email address.)
- Phones (`phones`, list): A list of phone numbers associated with the person. (Specify type and value, isPrimary is not expected. The first phone in the list will be the primary phone number.)
- Addresses (`addresses`, list): A list of addresses associated with the person. (These are the addresses where this person can be contacted, it is not the address of a property this person may be interested in selling or buying).
- Tags (`tags`, list): A list of tags applied to the person.
- Background (`background`, text): Background information on the person. (Can be a multi-line string.)
- Collaborators (`collaborators`, list): List of user ids to set as collaborators on this person. Not including a collaborator's user id in this array will remove them as a collaborator.
- Custom (`custom`, text): You can include any of your Custom Fields in the request, these must be prefixed with "custom". For example, if you have a *Closing Date* custom field, the JSON key for that field will be `customClosingDate`. See [Custom Fields](doc:custom-fields-get) for more about Custom Fields.
- Timeframe ID (`timeframe_id`, number): ID of the timeframe to move (Refer to the /timeframes endpoint for valid values of timeframeId.)

**Outputs**

- `data` (object): Returned value.

**Example output**

```json
{
  "data": {
    "body": "example",
    "created": "example",
    "firstName": "example",
    "id": 1,
    "lastName": "example",
    "name": "example",
    "updated": "example"
  }
}
```

### Create task

Create task.

**Inputs**

- Person ID (`person_id`, number, required): The id of the person this task is related to.
- Assigned user (`assigned_user_id`, number, required): The id of the user to assign to this task. (Note: This is required if `assignedTo` is empty.)
- Name (`name`, text, required): The name of the task.
- Type (`type`, text): Type can be one of the following: `Follow Up`, `Call`, `Text`, `Email`, `Appointment`, `Showing`, `Closing`, `Open House` or `Thank You`. One of: `Follow Up`, `Call`, `Text`, `Email`, `Appointment`, `Showing`, `Closing`, `Open House`, `Thank You`.
- Is completed (`is_completed`, true/false): Sets whether the task is completed or not.
- Due date (`due_date`, date): Due date for this task in YYYY-MM-DD format.
- Due date time (`due_date_time`, date and time): Due date for this task with a time included that also supports timezone suffixes. (e.g., 2004-11-16T03:00:00 -05:00)
- Remind seconds before (`remind_seconds_before`, number): Set a reminder for the task to be sent via email and desktop notification. This is only available for tasks with a due time set.

**Outputs**

- `data` (object): Response.

**Example output**

```json
{
  "data": {
    "AssignedTo": "example",
    "assignedUserId": 1,
    "completed": "example",
    "created": "example",
    "createdBy": "example",
    "dueDate": "example",
    "dueDateTime": "example",
    "id": 1,
    "isCompleted": 1,
    "name": "example",
    "person": {
      "id": 1,
      "name": "example"
    },
    "personId": 1,
    "type": "example",
    "updated": "example",
    "updatedBy": "example"
  }
}
```

### Delete note

Delete note.

**Inputs**

- Id (`id`, number, required): Id.

**Outputs**

- `data` (object): Returned value.

**Example output**

```json
{
  "data": {
    "body": "example",
    "created": "example",
    "firstName": "example",
    "id": 1,
    "lastName": "example",
    "name": "example",
    "updated": "example"
  }
}
```

### Delete person

Delete person.

**Inputs**

- Id (`id`, number, required): Id.

**Outputs**

- `data` (object): Returned value.

**Example output**

```json
{
  "data": {
    "body": "example",
    "created": "example",
    "firstName": "example",
    "id": 1,
    "lastName": "example",
    "name": "example",
    "updated": "example"
  }
}
```

### Delete task

Delete task.

**Inputs**

- Id (`id`, number, required): Id.

**Outputs**

- `data` (object): Returned value.

**Example output**

```json
{
  "data": {
    "body": "example",
    "created": "example",
    "firstName": "example",
    "id": 1,
    "lastName": "example",
    "name": "example",
    "updated": "example"
  }
}
```

### Get event

Get event.

**Inputs**

- Id (`id`, number, required): Id.

**Outputs**

- `data` (object): Response.

**Example output**

```json
{
  "data": {
    "created": "example",
    "description": "example",
    "id": 1,
    "message": "example",
    "noteId": 1,
    "personId": 1,
    "property": {
      "area": "example",
      "bathrooms": "example",
      "bedrooms": "example",
      "city": "example",
      "code": "example",
      "forRent": "example",
      "lot": "example",
      "mlsNumber": "example",
      "price": "example",
      "state": "example",
      "street": "example",
      "type": "example",
      "url": "example"
    },
    "propertySearch": {
      "action": "example",
      "city": "example",
      "code": "example",
      "forRent": 1,
      "keywordList": [],
      "maxArea": 1,
      "maxBathrooms": 1,
      "maxBedrooms": 1,
      "maxHoaFee": 1,
      "maxPrice": 1,
      "minArea": 1,
      "minBathrooms": 1,
      "minBedrooms": 1,
      "minParkingSpot": 1,
      "minPrice": 1,
      "minYearBuilt": 1,
      "neighborhood": "example",
      "state": "example",
      "statusTypes": [],
      "type": "example",
      "zillowSsid": "example"
    },
    "source": "example",
    "type": "example",
    "updated": "example"
  }
}
```

### Get IDentity

Get IDentity.

**Inputs**: None.

**Outputs**

- `data` (object): Returned value.

**Example output**

```json
{
  "data": {
    "account": {
      "domain": "example",
      "id": 1,
      "owner": {
        "email": "example",
        "name": "example"
      }
    },
    "user": {
      "email": "example",
      "id": 1,
      "name": "example"
    }
  }
}
```

### Get note

Get note.

**Inputs**

- Id (`id`, number, required): Id.
- Include threaded replies (`include_threaded_replies`, true/false): Include threaded replies.
- Include reactions (`include_reactions`, true/false): Include reactions.

**Outputs**

- `data` (object): Returned value.

**Example output**

```json
{
  "data": {
    "body": "example",
    "created": "example",
    "firstName": "example",
    "id": 1,
    "lastName": "example",
    "name": "example",
    "updated": "example"
  }
}
```

### Get person

Get person.

**Inputs**

- Id (`id`, number, required): Id.
- Fields (`fields`, text): Fields.

**Outputs**

- `data` (object): Returned value.

**Example output**

```json
{
  "data": {
    "body": "example",
    "created": "example",
    "firstName": "example",
    "id": 1,
    "lastName": "example",
    "name": "example",
    "updated": "example"
  }
}
```

### Get task

Get task.

**Inputs**

- Id (`id`, number, required): Id.

**Outputs**

- `data` (object): Response.

**Example output**

```json
{
  "data": {
    "AssignedTo": "example",
    "assignedUserId": 1,
    "completed": "example",
    "created": "example",
    "createdBy": "example",
    "dueDate": "example",
    "dueDateTime": "example",
    "id": 1,
    "isCompleted": 1,
    "name": "example",
    "person": {
      "id": 1,
      "name": "example"
    },
    "personId": 1,
    "type": "example",
    "updated": "example",
    "updatedBy": "example"
  }
}
```

### List events

List events.

**Inputs**

- Limit (`limit`, number): Limit. Default: `10`.
- Next (`next`, text): Next.
- Offset (`offset`, number): Offset. Default: `0`.
- Person ID (`person_id`, number): Person ID.
- Type (`type`, text): Type.
- Has property (`has_property`, true/false): Has property.
- Property address (`property_address`, text): Property address.

**Outputs**

- `data` (object): Response.

**Example output**

```json
{
  "data": {
    "_metadata": {
      "collection": "example",
      "limit": 1,
      "next": "example",
      "nextLink": "example",
      "offset": 1,
      "total": 1
    },
    "events": []
  }
}
```

### List people

List people.

**Inputs**

- Id (`id`, text): Id.
- Sort (`sort`, text): Sort. Default: `created`.
- Limit (`limit`, number): Limit. Default: `10`.
- Offset (`offset`, number): Offset. Default: `0`.
- Fields (`fields`, text): Fields.
- Last activity after (`last_activity_after`, text): Last activity after.
- Last activity before (`last_activity_before`, text): Last activity before.
- Name (`name`, text): Name.
- First name (`first_name`, text): First name.
- Last name (`last_name`, text): Last name.
- Email (`email`, text): Email.
- Phone (`phone`, text): Phone.
- Stage (`stage`, text): Stage.
- Source (`source`, text): Source.
- Assigned user (`assigned_user_id`, number): Assigned user ID.
- Assigned pond ID (`assigned_pond_id`, number): Assigned pond ID.
- Assigned lender name (`assigned_lender_name`, text): Assigned lender name.
- Assigned lender ID (`assigned_lender_id`, number): Assigned lender ID.
- Contacted (`contacted`, true/false): Contacted.
- Price above (`price_above`, number): Price above.
- Price below (`price_below`, number): Price below.
- Smart list ID (`smart_list_id`, number): Smart list ID.
- Include trash (`include_trash`, true/false): Include trash. Default: `false`.
- Include unclaimed (`include_unclaimed`, true/false): Include unclaimed. Default: `false`.
- Tags (`tags`, text): Tags.
- Custom (`custom`, text): Custom.
- Next (`next`, text): Next.

**Outputs**

- `data` (object): Returned value.

**Example output**

```json
{
  "data": {
    "_metadata": {},
    "people": []
  }
}
```

### List stages

List stages.

**Inputs**

- Limit (`limit`, number): Limit. Default: `10`.
- Offset (`offset`, number): Offset. Default: `0`.
- Sort (`sort`, text): Sort. Default: `orderWeight`.
- Next (`next`, text): Next.

**Outputs**

- `data` (object): Response.

**Example output**

```json
{
  "data": {
    "_metadata": {
      "collection": "example",
      "limit": 1,
      "offset": 1,
      "total": 1
    },
    "stages": []
  }
}
```

### List tasks

List tasks.

**Inputs**

- Person ID (`person_id`, number): Person ID.
- Assigned user (`assigned_user_id`, number): Assigned user ID.
- Name (`name`, text): Name.
- Type (`type`, text): Type.
- Is completed (`is_completed`, true/false): Is completed.
- Due (`due`, text): Due.
- Due start (`due_start`, date and time): Due start.
- Due end (`due_end`, date and time): Due end.
- Next (`next`, text): Next.

**Outputs**

- `data` (object): Returned value.

**Example output**

```json
{
  "data": {
    "_metadata": {},
    "tasks": []
  }
}
```

### List users

List users.

**Inputs**

- Limit (`limit`, number): Limit. Default: `10`.
- Offset (`offset`, number): Offset. Default: `0`.
- Sort (`sort`, text): Sort.
- Role (`role`, text): Role.
- Name (`name`, text): Name.
- Email (`email`, text): Email.
- Fields (`fields`, text): Fields.
- Include deleted (`include_deleted`, true/false): Include deleted. Default: `false`.
- Next (`next`, text): Next.

**Outputs**

- `data` (object): Returned value.

**Example output**

```json
{
  "data": {
    "_metadata": {},
    "users": []
  }
}
```

### Update note

Update note.

**Inputs**

- Id (`id`, number, required): Id.
- Person ID (`person_id`, number): The ID of a person associated with this note.
- Subject (`subject`, text): You can give a note a title or subject using this field.
- Body (`body`, text): The content of the note.
- Is html (`is_html`, true/false): If enabled, will render the HTML tags contained within the body on the Follow Up Boss user interface.

**Outputs**

- `data` (object): Response.

**Example output**

```json
{
  "data": {
    "body": "example",
    "created": "example",
    "createdBy": "example",
    "id": 1,
    "isHtml": 1,
    "personId": 1,
    "subject": "example",
    "type": "example",
    "updated": "example",
    "updatedBy": "example"
  }
}
```

### Update person

Update person.

**Inputs**

- Id (`id`, number, required): Id.
- Merge tags (`merge_tags`, true/false): Merge tags. Default: `false`.
- First name (`first_name`, text): The first/given name of the person.
- Last name (`last_name`, text): The last/family name of the person.
- Stage (`stage`, text): The stage the person is in. (e.g., "Lead" or "Trash". See [stage API endpoint](ref:stages-get) for more options.)
- Contacted (`contacted`, true/false): Whether the person has been contacted. (**Note**: Changing the `contacted` field to `true` will pause action plans.)
- Price (`price`, number): The price of the property of the person's first inquiry, or the estimated sell/buy price for this person.
- Assigned user (`assigned_user_id`, number): ID of the agent assigned to this person.
- Assigned pond ID (`assigned_pond_id`, number): ID of the pond assigned to this person.
- Assigned lender name (`assigned_lender_name`, text): Full name of the lender assigned to this person.
- Assigned lender ID (`assigned_lender_id`, number): ID of the lender assigned to this person.
- Emails (`emails`, list): A list of email addresses associated with the person.
- Phones (`phones`, list): A list of phone numbers associated with the person.
- Addresses (`addresses`, list): A list of addresses associated with the person. (This is the address where this person can be contacted, it is not the address of a property this person may be interested in selling or buying).
- Tags (`tags`, list): A list of tags applied to the person. **This list will overwrite any existing tags for the person.** (To merge the tags passed with any existing tags,set the `mergeTags` query parameter in your request to true.)
- Background (`background`, text): Background information on the person. (Can be a multi-line string.)
- Custom (`custom`, text): You can include any of your Custom Fields in the request, these must be prefixed with "custom". For example, if you have a *Closing Date* custom field, the JSON key for that field will be `customClosingDate`. See [Custom Fields](doc:custom-fields-get) for more about Custom Fields.
- Timeframe ID (`timeframe_id`, number): ID of the timeframe to move (Refer to the /timeframes endpoint for valid values of timeframeId.)

**Outputs**

- `data` (object): Returned value.

**Example output**

```json
{
  "data": {
    "body": "example",
    "created": "example",
    "firstName": "example",
    "id": 1,
    "lastName": "example",
    "name": "example",
    "updated": "example"
  }
}
```

### Update task

Update task.

**Inputs**

- Id (`id`, number, required): Id.
- Person ID (`person_id`, number): The id of the person this task is related to.
- Assigned user (`assigned_user_id`, number): The id of the user to assign to this task.
- Name (`name`, text): The name of the task.
- Type (`type`, text): Type can be one of the following: `Follow Up`, `Call`, `Email`, `Appointment`, `Showing`, `Closing`, `Open House` or `Thank You`. One of: `Follow Up`, `Call`, `Text`, `Email`, `Appointment`, `Showing`, `Closing`, `Open House`, `Thank You`.
- Is completed (`is_completed`, true/false): Sets whether the task is completed or not.

**Outputs**

- `data` (object): Returned value.

**Example output**

```json
{
  "data": {
    "body": "example",
    "created": "example",
    "firstName": "example",
    "id": 1,
    "lastName": "example",
    "name": "example",
    "updated": "example"
  }
}
```
