# BoldTrail

> Manage BoldTrail contacts, notes, calls, tags, and account directories with the Public API V2.

App · 25 actions. Web page: https://docs.lodol.com/docs/integrations/boldtrail

## Actions

### Add a note

Add a Note

**Inputs**

- Contact id (`contact_id`, text, required): ID of the contact.
- Date (`date`, date and time): Date to specify with the note. Default is the current date/time.
- Title (`title`, text): The title of the note.
- Details (`details`, text): The content/body of the note. The note body supports include hashtags that will automatically be parsed and added as a hashtag on the contact as well.
- Action owner user id (`action_owner_user_id`, text): The owner user id for the action (when creating on behalf of another user). This is only available to company admins. If specified by non-company admin this field will be ignored and the user associated with the token will be used.

**Outputs**

- `data` (object): Bold Trail response data.

**Example output**

```json
{
  "data": {
    "action_owner_user_id": "example",
    "date": "example",
    "details": "example",
    "title": "example"
  }
}
```

### Add tags to contact

Add Tags to Contact

**Inputs**

- Contact id (`contact_id`, text, required): ID of the contact.
- Tags (`tags`, list): Tags.

**Outputs**

- `data` (object): Bold Trail response data.

**Example output**

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

### Create contact

Create New Contact

**Inputs**

- First name (`first_name`, text, required): First name of contact.
- Last name (`last_name`, text, required): Last name of contact.
- Email (`email`, text, required): Email address for the contact.
- Cell phone 1 (`cell_phone_1`, number): Cell phone for the contact. Will be used as the primary phone.
- Home phone (`home_phone`, number): Home phone for the contact.
- Work phone (`work_phone`, number): Work phone for the contact.
- Fax (`fax`, text): Fax number for the contact.
- Deal type (`deal_type`, text): The deal types for the contact. Values can be a combination of buyer,seller,renter
- Primary city (`primary_city`, text): City of the contact lives in.
- Primary state (`primary_state`, text): State the contact lives in.
- Primary zip (`primary_zip`, text): Postal code the contact lives in.
- Primary address (`primary_address`, text): Address the contact lives in.
- Status (`status`, number): The status of the lead. 0 - New, 1 - Client, 2 - Closed, 3 - Sphere, 4 - Active, 5 - Contract, 6 - Archived, 7 - Prospect. One of: `0` (New), `1` (Client), `2` (Closed), `3` (Sphere), `4` (Active), `5` (Contract), `6` (Archived), `7` (Prospect).
- Source (`source`, text): Top-level source the contact originated from.
- Email optin (`email_optin`, number): Set to 1 if the contact should get automated emails; otherwise 0. One of: `0` (Do not send automated email), `1` (Send automated email).
- Phone on (`phone_on`, number): Set to 1 if the contact should be contacted via phone; otherwise 0. One of: `0` (Off), `1` (On).
- Text on (`text_on`, number): Set to 1 if the contact should get automated texts; otherwise 0. One of: `0` (Off), `1` (On).
- Rating (`rating`, number): Value can be set to a range from 0-5, 0 being a poor quality contact, 5 being the best.
- Capture method (`capture_method`, text): What method was used to capture the lead. This can be anything, but would be something like "Website Lead Capture" or "Dropbox".
- Assigned agent id (`assigned_agent_id`, text): User ID of the agent the contact will be assigned to. If a user ID is not specified, the contact will be run through lead routing rules. This only works if the contact is not already assigned to an agent.
- Assigned agent external id (`assigned_agent_external_id`, text): External ID of the agent to assign the contact to (maps to external_vendor_id of the user). If assigned_agent_id is specified, that will be used instead of this value. This only works if the contact is not already assigned to an agent.
- Tcpa optin date (`tcpa_optin_date`, date and time): Optionally specify whether or not the contact has opted-in to receive automated text messaging. If omitted, automated text messaging will be on by default.
- Avg price (`avg_price`, number): Average price of viewed listings.
- Avg beds (`avg_beds`, number): Average number of beds of viewed listings.
- Avg baths (`avg_baths`, number): Average number of baths of viewed listings.
- Is private (`is_private`, number): Whether or not the lead should be hidden from team, office, and company admins. (Only applicable if account has lead privacy turned on). Default is 0. Default: `0`.
- Active mls id (`active_mls_id`, text): If the lead is a seller, then this is the MLS ID of the listing they are selling.
- Signup mlsid (`signup_mlsid`, text): Optional unique identifier for the MLS (Multiple Listing Service) provided during the signup process. Facilitates the association of the user with a specific MLS, enhancing interactions within the platform. Used for Lead Routing.
- Signup mls (`signup_mls`, number): Optional integer identifier to identify the specific mls board for the signup_mlsid. Used when the account has multiple MLS boards. Allows the correct property to be used for Lead Routing.
- Spouse first name (`spouse_first_name`, text): First name of the contact's spouse.
- Spouse last name (`spouse_last_name`, text): Last name of the contact's spouse.
- Spouse phone (`spouse_phone`, text): Phone number of the contact's spouse.
- Spouse title (`spouse_title`, text): Title of the contact's spouse.
- Title (`title`, text): Title of the contact.
- Birthday (`birthday`, text): Birthday of the contact.
- Gender (`gender`, text): Gender of the contact.
- Poi address (`poi_address`, text): Address of the property of interest.
- Poi city (`poi_city`, text): City of the property of interest.
- Poi state (`poi_state`, text): State of the property of interest.
- Poi zip (`poi_zip`, text): Zip of the property of interest.
- Second email (`second_email`, text): Secondary email for the contact.
- External vendor id (`external_vendor_id`, text): External ID of the contact that can be set for tracking it in an external system.
- Owned by assigned (`owned_by_assigned`, true/false): Allows super scoped tokens to override super account lead ownership by setting them to be owned by the assigned agent.
- Entity owner id (`entity_owner_id`, text): Routes contact to specified entity, created contact will then be routed through the specified entity's lead routing rules.
- Skip new notification (`skip_new_notification`, true/false): When set to true notifications will be skipped.
- Last closing date (`last_closing_date`, text): The date of contact's last closing.
- Hashtags (`hashtags`, text): Hashtags that apply to the contact. Must include # before the tag. Hashtags added at creation will be used in lead matching.

**Outputs**

- `data` (object): Bold Trail response data.

**Example output**

```json
{
  "data": {
    "active_mls_id": "example",
    "assigned_agent_external_id": "example",
    "assigned_agent_id": "example",
    "avg_baths": 1,
    "avg_beds": 1,
    "avg_price": 1,
    "birthday": "example",
    "capture_method": "example",
    "cell_phone_1": 1,
    "deal_type": "example",
    "email": "example",
    "email_optin": 1,
    "entity_owner_id": 1,
    "external_vendor_id": "example",
    "fax": "example",
    "first_name": "example",
    "gender": "example",
    "hashtags": "example",
    "home_phone": 1,
    "is_private": 1,
    "last_closing_date": "example",
    "last_name": "example",
    "owned_by_assigned": false,
    "phone_on": 1,
    "poi_address": "example",
    "poi_city": "example",
    "poi_state": "example",
    "poi_zip": "example",
    "primary_address": "example",
    "primary_city": "example",
    "primary_state": "example",
    "primary_zip": "example",
    "rating": 1,
    "second_email": "example",
    "skip_new_notification": false,
    "source": "example",
    "spouse_first_name": "example",
    "spouse_last_name": "example",
    "spouse_phone": "example",
    "spouse_title": "example",
    "status": 0,
    "tcpa_optin_date": "example",
    "text_on": 1,
    "title": "example",
    "work_phone": 1
  }
}
```

### Delete contact

Remove Contact

**Inputs**

- Contact id (`contact_id`, text, required): ID of the contact.

**Outputs**

- `data` (text): Bold Trail response data.

**Example output**

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

### Get calls list

Get Calls List

**Inputs**

- Contact id (`contact_id`, text, required): ID of the contact.

**Outputs**

- `data` (object): Bold Trail response data.

**Example output**

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

### Get contact

Get Contact Details

**Inputs**

- Contact id (`contact_id`, text, required): ID of the contact.

**Outputs**

- `data` (object): Bold Trail response data.

**Example output**

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

### Get manual listing details

Get Manual Listing Details

**Inputs**

- Manual listing id (`manual_listing_id`, text, required): ID of the manual listing. This can be either the generated ID or the external_id specified during creation.

**Outputs**

- `data` (object): Bold Trail response data.

**Example output**

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

### Get manual listing property types

Get Manual Listing Property Types

**Inputs**: None.

**Outputs**

- `data` (object): Bold Trail response data.

**Example output**

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

### Get manual listings list

Get Manual Listings List

**Inputs**: None.

**Outputs**

- `data` (object): Bold Trail response data.

**Example output**

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

### Get note details

Get Note Details

**Inputs**

- Contact id (`contact_id`, text, required): ID of the contact.
- Action id (`action_id`, text, required): ID of the action to get.

**Outputs**

- `data` (object): Bold Trail response data.

**Example output**

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

### Get notes list

Get Notes List

**Inputs**

- Contact id (`contact_id`, text, required): ID of the contact.

**Outputs**

- `data` (object): Bold Trail response data.

**Example output**

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

### Get office details

Get Office Details

**Inputs**

- Office id (`office_id`, text, required): ID of the office.

**Outputs**

- `data` (object): Bold Trail response data.

**Example output**

```json
{
  "data": {
    "about": {},
    "about_alt_french": {},
    "address": {},
    "business_photo": {},
    "city": {},
    "division": {},
    "docusign_office_id": {},
    "email": {},
    "external_vendor_id": {},
    "fax": {},
    "id": {},
    "lat": {},
    "lng": {},
    "location": {},
    "mls_id": {},
    "name": {},
    "organization_name": {},
    "phone": {},
    "photo": {},
    "region": {},
    "show_user_on_site": {},
    "state": {},
    "status": {},
    "tagline": {},
    "visibility": {},
    "zip": {}
  }
}
```

### Get office list

Get Office List

**Inputs**

- Limit (`limit`, number): Defines the per page limit for pagination. Default is 50.
- Page (`page`, number): Specifies the page to return for pagination.

**Outputs**

- `data` (object): Bold Trail response data.

**Example output**

```json
{
  "data": {
    "current_page": {},
    "data": {
      "external_vendor_id": {},
      "id": {},
      "name": {},
      "type": {}
    },
    "first_page_url": {},
    "from": {},
    "last_page": {},
    "last_page_url": {},
    "next_page_url": {},
    "path": {},
    "per_page": {},
    "prev_page_url": {},
    "to": {},
    "total": {}
  }
}
```

### Get tag list

Get Tag List

**Inputs**

- Contact id (`contact_id`, text, required): ID of the contact.

**Outputs**

- `data` (object): Bold Trail response data.

**Example output**

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

### Get team details

Get Team Details

**Inputs**

- Team id (`record_team_id`, text, required): ID of the team.

**Outputs**

- `data` (object): Bold Trail response data.

**Example output**

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

### Get team list

Get Team List

**Inputs**: None.

**Outputs**

- `data` (text): Bold Trail response data.

**Example output**

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

### Get user calls

Get User Calls

**Inputs**

- User id (`record_user_id`, text, required): ID of the user.

**Outputs**

- `data` (object): Bold Trail response data.

**Example output**

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

### Get user details

Get User Details

**Inputs**

- User id (`record_user_id`, text, required): ID of the user.

**Outputs**

- `data` (object): Bold Trail response data.

**Example output**

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

### Get user list

Get User List

**Inputs**

- Offices[] (`offices`, number): Filters the users by those that are a member of the specified office(s). Value is the id of the office. Multiple values can be passed (e.g., offices[]=1&offices[]=2 ).
- Lenders[] (`lenders`, number): Filters the users by those who have the specified default lender(s). Value is the id of the lender. Multiple values can be passed (e.g., lenders[]=1&lenders[]=2 ).
- Teams[] (`teams`, number): Filters the users by those that are a member of the specified team(s). Value is the id of the team. Multiple values can be passed (e.g., teams[]=1&teams[]=2 ).
- Since (`since`, text): Filters to users with an updated_at date greater than the date specified. Times are UTC. (Note: The data type for the value passed is datetime.)
- Before (`before`, text): Filters to users with an updated_at date less than the date specified. Times are UTC. (Note: The data type for the value passed is datetime.)
- Status (`status`, number): Filters users to the status specified. 1 = Active, 0 = Roster Only.
- Mls id (`mls_id`, text): Filters results to users with the associated mls id(s). Multiple values can be passed (e.g., mls_id=ID1,ID2,ID3 ).

**Outputs**

- `data` (object): Bold Trail response data.

**Example output**

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

### Get user tasks

Get User Tasks

**Inputs**

- User id (`record_user_id`, text, required): ID of the user.

**Outputs**

- `data` (object): Bold Trail response data.

**Example output**

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

### List contacts

Get Contacts List

**Inputs**

- Filter[email] (`filter_email`, text): This will return any contacts whose email matches the specified string exactly or where contact.email is like the specified string. We add wildcards to the end of the string to determine likeness. Possible Values include the following: Any string. An example is "?filter[email]=test@test.com".
- Filter[first name] (`filter_first_name`, text): This will return any contacts whose first name matches the specified string exactly or where contact.first_name is like the specified string. We add wildcards to the end of the string to determine likeness. Possible Values include the following: Any string. An example is "?filter[first_name]=testfirstname".
- Filter[last name] (`filter_last_name`, text): This will return any contacts whose last name matches the specified string exactly or where contact.last_name is like the specified string. We add wildcards to the end of the string to determine likeness. Possible Values include the following: Any string. An example is "?filter[last_name]=testlastname".
- Filter[updated at] (`filter_updated_at`, number): This will return any contacts who have an updated timestamp >= the specified value. Possible Values include the following: Unix Timestamp, YYYY-MM-DD, or YYYY-MM-DD HH:MM:SS. An example is "?filter[updated_at]=1584595231".
- Filter[source][] (`filter_source`, text): This will return contacts with source = specified string. Possible Values include the following: Any String. An example is "?filter[source][]=Open House".
- Filter[system source][] (`filter_system_source`, text): This will return contacts with system_source = specified string. Possible Values include the following: Any String. An example is "?filter[system_source][]=API".
- Filter[leadtype][] (`filter_leadtype`, text): This will return contacts with leadtype = specified explicit Value(s). If you want to filter by multiple lead types, then you'll need to add another filter[leadtype][] param to the url string. Possible Values include the following: "buyer", "seller", "renter", "agent", "vendor". An example is.
- Filter[registered after] (`filter_registered_after`, number): Pass in a timestamp as the value in order to find contacts registered after that time. Possible Values include the following: Unix Timestamp. An example is "?filter[registered_after]=1581188318".
- Filter[registered before] (`filter_registered_before`, number): Pass in a timestamp as the value in order to find contacts registered before that time. Possible Values include the following: Unix Timestamp. An example is "?filter[registered_before]=1612810718".
- Filter[status][] (`filter_status`, number): Pass a status value to return only leads of that status. Possible Values (can be set as one of the following integers): "0" - New, "1" - Client, "2" - Closed, "3" - Sphere, "4" - Active, "5" - Contract, "7" - Prospect. An example is "?filter[status]=7".
- Filter[assigned agent id] (`filter_assigned_agent_id`, text): Filter leads assigned to the given agent id. Possible Values include the following: Any integer used as an agent id. An example is "?filter[assigned_agent_id]=123".
- Filter[hashtags] (`filter_hashtags`, text): This will return contacts with specific hashtags. If you want to filter by multiple lead types, then you'll need to add another filter[hashtag][] param to the url string. An example is "?filter[hashtags][]=tag1&filter[hashtags][]=tag2".
- Include archived (`include_archived`, number): This will return all archived leads when value set as "1". Possible Values (can be set as one of the following integers): "0" - don't include archived, "1" - include archived. An example is "?includeArchived=1".
- Limit (`limit`, number): This will limit the number of results displayed in the returned data array. Possible Values include the following: Any integer. An example is "?limit=25".

**Outputs**

- `data` (object): Bold Trail response data.

**Example output**

```json
{
  "data": {
    "assigned_agent_external_id": "example",
    "assigned_agent_id": 1,
    "created_at": "example",
    "email": "example",
    "external_vendor_id": "example",
    "id": 1,
    "name": "example",
    "registered": "example",
    "status": 0,
    "updated_at": "example"
  }
}
```

### Log a call

Log a Call

**Inputs**

- Contact id (`contact_id`, text, required): ID of the contact.
- Date (`date`, date and time): Date the call occcured. Default is the current date/time.
- Direction (`direction`, text): Options are 'outbound' or 'inbound'. Defaults to 'outbound' if not specified. One of: `outbound`, `inbound`.
- Result (`result`, number): Options are 1 = Bad Number, 2 = Not Home, 3 = Contacted. Defaults to 3 if not specified. One of: `0` (Unspecified), `1` (Bad number), `2` (Not home), `3` (Contacted).
- Recording url (`recording_url`, text): The URL to the call recording audio file.
- Action owner user id (`action_owner_user_id`, text): The owner user id for the action (when creating on behalf of another user). This is only available to company admins. If specified by non-company admin this field will be ignored and the user associated with the token will be used.
- Notes (`notes`, text): Notes about the call that was made.

**Outputs**

- `data` (object): Bold Trail response data.

**Example output**

```json
{
  "data": {
    "action_owner_user_id": "example",
    "date": "example",
    "direction": "example",
    "notes": "example",
    "recording_url": "example",
    "result": 0
  }
}
```

### Remove tags from contact

Remove Tags from Contact

**Inputs**

- Contact id (`contact_id`, text, required): ID of the contact.

**Outputs**

- `data` (object): Bold Trail response data.

**Example output**

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

### Update a note

Update a Note

**Inputs**

- Contact id (`contact_id`, text, required): ID of the contact.
- Action id (`action_id`, text, required): ID of the action to get.
- Date (`date`, date and time): Date to specify with the note. Default is the current date/time.
- Title (`title`, text): The title of the note.
- Details (`details`, text): The content/body of the note. The note body supports include hashtags that will automatically be parsed and added as a hashtag on the contact as well.
- Action owner user id (`action_owner_user_id`, text): The owner user id for the action (when creating on behalf of another user). This is only available to company admins. If specified by non-company admin this field will be ignored and the user associated with the token will be used.

**Outputs**

- `data` (object): Bold Trail response data.

**Example output**

```json
{
  "data": {
    "action_owner_user_id": "example",
    "date": "example",
    "details": "example",
    "title": "example"
  }
}
```

### Update contact

Update Contact

**Inputs**

- Contact id (`contact_id`, text, required): ID of the contact.
- First name (`first_name`, text): First name of contact.
- Last name (`last_name`, text): Last name of contact.
- Email (`email`, text): Email address for the contact.
- Cell phone 1 (`cell_phone_1`, number): Cell phone for the contact. Will be used as the primary phone.
- Home phone (`home_phone`, number): Home phone for the contact.
- Work phone (`work_phone`, number): Work phone for the contact.
- Fax (`fax`, text): Fax number for the contact.
- Deal type (`deal_type`, text): The deal types for the contact. Values can be a combination of buyer,seller,renter
- Primary city (`primary_city`, text): City of the contact lives in.
- Primary state (`primary_state`, text): State the contact lives in.
- Primary zip (`primary_zip`, text): Postal code the contact lives in.
- Primary address (`primary_address`, text): Address the contact lives in.
- Status (`status`, number): The status of the lead. 0 - New, 1 - Client, 2 - Closed, 3 - Sphere, 4 - Active, 5 - Contract, 6 - Archived, 7 - Prospect. One of: `0` (New), `1` (Client), `2` (Closed), `3` (Sphere), `4` (Active), `5` (Contract), `6` (Archived), `7` (Prospect).
- Source (`source`, text): Top-level source the contact originated from.
- Email optin (`email_optin`, number): Set to 1 if the contact should get automated emails; otherwise 0. One of: `0` (Do not send automated email), `1` (Send automated email).
- Phone on (`phone_on`, number): Set to 1 if the contact should be contacted via phone; otherwise 0. One of: `0` (Off), `1` (On).
- Text on (`text_on`, number): Set to 1 if the contact should get automated texts; otherwise 0. One of: `0` (Off), `1` (On).
- Rating (`rating`, number): Value can be set to a range from 0-5, 0 being a poor quality contact, 5 being the best.
- Capture method (`capture_method`, text): What method was used to capture the lead. This can be anything, but would be something like "Website Lead Capture" or "Dropbox".
- Assigned agent id (`assigned_agent_id`, text): User ID of the agent the contact will be assigned to. If a user ID is not specified, the contact will be run through lead routing rules. This only works if the contact is not already assigned to an agent.
- Assigned agent external id (`assigned_agent_external_id`, text): External ID of the agent to assign the contact to (maps to external_vendor_id of the user). If assigned_agent_id is specified, that will be used instead of this value. This only works if the contact is not already assigned to an agent.
- Tcpa optin date (`tcpa_optin_date`, date and time): Optionally specify whether or not the contact has opted-in to receive automated text messaging. If omitted, automated text messaging will be on by default.
- Avg price (`avg_price`, number): Average price of viewed listings.
- Avg beds (`avg_beds`, number): Average number of beds of viewed listings.
- Avg baths (`avg_baths`, number): Average number of baths of viewed listings.
- Is private (`is_private`, number): Whether or not the lead should be hidden from team, office, and company admins. (Only applicable if account has lead privacy turned on). Default is 0.
- Active mls id (`active_mls_id`, text): If the lead is a seller, then this is the MLS ID of the listing they are selling.
- Spouse first name (`spouse_first_name`, text): First name of the contact's spouse.
- Spouse last name (`spouse_last_name`, text): Last name of the contact's spouse.
- Spouse title (`spouse_title`, text): Title of the contact's spouse.
- Spouse phone (`spouse_phone`, text): Phone number of the contact's spouse.
- Title (`title`, text): Title of the contact.
- Birthday (`birthday`, text): Birthday of the contact.
- Gender (`gender`, text): Gender of the contact.
- Poi address (`poi_address`, text): Address of the property of interest.
- Poi city (`poi_city`, text): City of the property of interest.
- Poi state (`poi_state`, text): State of the property of interest.
- Poi zip (`poi_zip`, text): Zip of the property of interest.
- Second email (`second_email`, text): Secondary email for the contact.
- External vendor id (`external_vendor_id`, text): External ID of the contact that can be set for tracking it in an external system.
- Skip new notification (`skip_new_notification`, true/false): When set to true notifications will be skipped.
- Last closing date (`last_closing_date`, text): The date of contact's last closing.

**Outputs**

- `data` (object): Bold Trail response data.

**Example output**

```json
{
  "data": {
    "active_mls_id": "example",
    "assigned_agent_external_id": "example",
    "assigned_agent_id": "example",
    "avg_baths": 1,
    "avg_beds": 1,
    "avg_price": 1,
    "birthday": "example",
    "capture_method": "example",
    "cell_phone_1": 1,
    "deal_type": "example",
    "email": "example",
    "email_optin": 1,
    "external_vendor_id": "example",
    "fax": "example",
    "first_name": "example",
    "gender": "example",
    "home_phone": 1,
    "is_private": 1,
    "last_closing_date": "example",
    "last_name": "example",
    "phone_on": 1,
    "poi_address": "example",
    "poi_city": "example",
    "poi_state": "example",
    "poi_zip": "example",
    "primary_address": "example",
    "primary_city": "example",
    "primary_state": "example",
    "primary_zip": "example",
    "rating": 1,
    "second_email": "example",
    "skip_new_notification": false,
    "source": "example",
    "spouse_first_name": "example",
    "spouse_last_name": "example",
    "spouse_phone": "example",
    "spouse_title": "example",
    "status": 0,
    "tcpa_optin_date": "example",
    "text_on": 1,
    "title": "example",
    "work_phone": 1
  }
}
```
