BoldTrail

App · 25 actions

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

Actions

ActionWhat it does
Add a noteAdd a Note
Add tags to contactAdd Tags to Contact
Create contactCreate New Contact
Delete contactRemove Contact
Get calls listGet Calls List
Get contactGet Contact Details
Get manual listing detailsGet Manual Listing Details
Get manual listing property typesGet Manual Listing Property Types
Get manual listings listGet Manual Listings List
Get note detailsGet Note Details
Get notes listGet Notes List
Get office detailsGet Office Details
Get office listGet Office List
Get tag listGet Tag List
Get team detailsGet Team Details
Get team listGet Team List
Get user callsGet User Calls
Get user detailsGet User Details
Get user listGet User List
Get user tasksGet User Tasks
List contactsGet Contacts List
Log a callLog a Call
Remove tags from contactRemove Tags from Contact
Update a noteUpdate a Note
Update contactUpdate Contact

Add a note

Add a Note

Inputs

Contact idcontact_idtextRequired
ID of the contact.
Datedatedate and time
Date to specify with the note. Default is the current date/time.
Titletitletext
The title of the note.
Detailsdetailstext
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 idaction_owner_user_idtext
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

dataobject
Bold Trail response data.
Example output
{
  "data": {
    "action_owner_user_id": "example",
    "date": "example",
    "details": "example",
    "title": "example"
  }
}

Add tags to contact

Add Tags to Contact

Inputs

Contact idcontact_idtextRequired
ID of the contact.
Tagstagslist
Tags.

Outputs

dataobject
Bold Trail response data.
Example output
{
  "data": {}
}

Create contact

Create New Contact

Inputs

First namefirst_nametextRequired
First name of contact.
Last namelast_nametextRequired
Last name of contact.
EmailemailtextRequired
Email address for the contact.
Cell phone 1cell_phone_1number
Cell phone for the contact. Will be used as the primary phone.
Home phonehome_phonenumber
Home phone for the contact.
Work phonework_phonenumber
Work phone for the contact.
Faxfaxtext
Fax number for the contact.
Deal typedeal_typetext
The deal types for the contact. Values can be a combination of buyer,seller,renter
Primary cityprimary_citytext
City of the contact lives in.
Primary stateprimary_statetext
State the contact lives in.
Primary zipprimary_ziptext
Postal code the contact lives in.
Primary addressprimary_addresstext
Address the contact lives in.
Statusstatusnumber
The status of the lead. 0 - New, 1 - Client, 2 - Closed, 3 - Sphere, 4 - Active, 5 - Contract, 6 - Archived, 7 - ProspectOne of: 0 (New), 1 (Client), 2 (Closed), 3 (Sphere), 4 (Active), 5 (Contract), 6 (Archived), 7 (Prospect).
Sourcesourcetext
Top-level source the contact originated from.
Email optinemail_optinnumber
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 onphone_onnumber
Set to 1 if the contact should be contacted via phone; otherwise 0.One of: 0 (Off), 1 (On).
Text ontext_onnumber
Set to 1 if the contact should get automated texts; otherwise 0.One of: 0 (Off), 1 (On).
Ratingratingnumber
Value can be set to a range from 0-5, 0 being a poor quality contact, 5 being the best.
Capture methodcapture_methodtext
What method was used to capture the lead. This can be anything, but would be something like "Website Lead Capture" or "Dropbox".
Assigned agent idassigned_agent_idtext
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 idassigned_agent_external_idtext
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 datetcpa_optin_datedate 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 priceavg_pricenumber
Average price of viewed listings.
Avg bedsavg_bedsnumber
Average number of beds of viewed listings.
Avg bathsavg_bathsnumber
Average number of baths of viewed listings.
Is privateis_privatenumber
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 idactive_mls_idtext
If the lead is a seller, then this is the MLS ID of the listing they are selling.
Signup mlsidsignup_mlsidtext
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 mlssignup_mlsnumber
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 namespouse_first_nametext
First name of the contact's spouse.
Spouse last namespouse_last_nametext
Last name of the contact's spouse.
Spouse phonespouse_phonetext
Phone number of the contact's spouse.
Spouse titlespouse_titletext
Title of the contact's spouse.
Titletitletext
Title of the contact.
Birthdaybirthdaytext
Birthday of the contact.
Gendergendertext
Gender of the contact.
Poi addresspoi_addresstext
Address of the property of interest.
Poi citypoi_citytext
City of the property of interest.
Poi statepoi_statetext
State of the property of interest.
Poi zippoi_ziptext
Zip of the property of interest.
Second emailsecond_emailtext
Secondary email for the contact.
External vendor idexternal_vendor_idtext
External ID of the contact that can be set for tracking it in an external system.
Owned by assignedowned_by_assignedtrue/false
Allows super scoped tokens to override super account lead ownership by setting them to be owned by the assigned agent.
Entity owner identity_owner_idtext
Routes contact to specified entity, created contact will then be routed through the specified entity's lead routing rules.
Skip new notificationskip_new_notificationtrue/false
When set to true notifications will be skipped.
Last closing datelast_closing_datetext
The date of contact's last closing.
Hashtagshashtagstext
Hashtags that apply to the contact. Must include # before the tag. Hashtags added at creation will be used in lead matching.

Outputs

dataobject
Bold Trail response data.
Example output
{
  "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 idcontact_idtextRequired
ID of the contact.

Outputs

datatext
Bold Trail response data.
Example output
{
  "data": "example"
}

Get calls list

Get Calls List

Inputs

Contact idcontact_idtextRequired
ID of the contact.

Outputs

dataobject
Bold Trail response data.
Example output
{
  "data": {}
}

Get contact

Get Contact Details

Inputs

Contact idcontact_idtextRequired
ID of the contact.

Outputs

dataobject
Bold Trail response data.
Example output
{
  "data": {}
}

Get manual listing details

Get Manual Listing Details

Inputs

Manual listing idmanual_listing_idtextRequired
ID of the manual listing. This can be either the generated ID or the external_id specified during creation.

Outputs

dataobject
Bold Trail response data.
Example output
{
  "data": {}
}

Get manual listing property types

Get Manual Listing Property Types

Inputs

None.

Outputs

dataobject
Bold Trail response data.
Example output
{
  "data": {}
}

Get manual listings list

Get Manual Listings List

Inputs

None.

Outputs

dataobject
Bold Trail response data.
Example output
{
  "data": {}
}

Get note details

Get Note Details

Inputs

Contact idcontact_idtextRequired
ID of the contact.
Action idaction_idtextRequired
ID of the action to get.

Outputs

dataobject
Bold Trail response data.
Example output
{
  "data": {}
}

Get notes list

Get Notes List

Inputs

Contact idcontact_idtextRequired
ID of the contact.

Outputs

dataobject
Bold Trail response data.
Example output
{
  "data": {}
}

Get office details

Get Office Details

Inputs

Office idoffice_idtextRequired
ID of the office.

Outputs

dataobject
Bold Trail response data.
Example output
{
  "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

Limitlimitnumber
Defines the per page limit for pagination. Default is 50.
Pagepagenumber
Specifies the page to return for pagination.

Outputs

dataobject
Bold Trail response data.
Example output
{
  "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 idcontact_idtextRequired
ID of the contact.

Outputs

dataobject
Bold Trail response data.
Example output
{
  "data": {}
}

Get team details

Get Team Details

Inputs

Team idrecord_team_idtextRequired
ID of the team.

Outputs

dataobject
Bold Trail response data.
Example output
{
  "data": {}
}

Get team list

Get Team List

Inputs

None.

Outputs

datatext
Bold Trail response data.
Example output
{
  "data": "example"
}

Get user calls

Get User Calls

Inputs

User idrecord_user_idtextRequired
ID of the user.

Outputs

dataobject
Bold Trail response data.
Example output
{
  "data": {}
}

Get user details

Get User Details

Inputs

User idrecord_user_idtextRequired
ID of the user.

Outputs

dataobject
Bold Trail response data.
Example output
{
  "data": {}
}

Get user list

Get User List

Inputs

Offices[]officesnumber
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[]lendersnumber
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[]teamsnumber
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 ).
Sincesincetext
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.)
Beforebeforetext
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.)
Statusstatusnumber
Filters users to the status specified. 1 = Active, 0 = Roster Only.
Mls idmls_idtext
Filters results to users with the associated mls id(s). Multiple values can be passed (e.g., mls_id=ID1,ID2,ID3 ).

Outputs

dataobject
Bold Trail response data.
Example output
{
  "data": {}
}

Get user tasks

Get User Tasks

Inputs

User idrecord_user_idtextRequired
ID of the user.

Outputs

dataobject
Bold Trail response data.
Example output
{
  "data": {}
}

List contacts

Get Contacts List

Inputs

Filter[email]filter_emailtext
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_nametext
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_nametext
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_atnumber
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_sourcetext
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_sourcetext
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_leadtypetext
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_afternumber
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_beforenumber
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_statusnumber
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_idtext
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_hashtagstext
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 archivedinclude_archivednumber
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".
Limitlimitnumber
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

dataobject
Bold Trail response data.
Example output
{
  "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 idcontact_idtextRequired
ID of the contact.
Datedatedate and time
Date the call occcured. Default is the current date/time.
Directiondirectiontext
Options are 'outbound' or 'inbound'. Defaults to 'outbound' if not specified.One of: outbound, inbound.
Resultresultnumber
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 urlrecording_urltext
The URL to the call recording audio file.
Action owner user idaction_owner_user_idtext
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.
Notesnotestext
Notes about the call that was made.

Outputs

dataobject
Bold Trail response data.
Example output
{
  "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 idcontact_idtextRequired
ID of the contact.

Outputs

dataobject
Bold Trail response data.
Example output
{
  "data": {}
}

Update a note

Update a Note

Inputs

Contact idcontact_idtextRequired
ID of the contact.
Action idaction_idtextRequired
ID of the action to get.
Datedatedate and time
Date to specify with the note. Default is the current date/time.
Titletitletext
The title of the note.
Detailsdetailstext
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 idaction_owner_user_idtext
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

dataobject
Bold Trail response data.
Example output
{
  "data": {
    "action_owner_user_id": "example",
    "date": "example",
    "details": "example",
    "title": "example"
  }
}

Update contact

Update Contact

Inputs

Contact idcontact_idtextRequired
ID of the contact.
First namefirst_nametext
First name of contact.
Last namelast_nametext
Last name of contact.
Emailemailtext
Email address for the contact.
Cell phone 1cell_phone_1number
Cell phone for the contact. Will be used as the primary phone.
Home phonehome_phonenumber
Home phone for the contact.
Work phonework_phonenumber
Work phone for the contact.
Faxfaxtext
Fax number for the contact.
Deal typedeal_typetext
The deal types for the contact. Values can be a combination of buyer,seller,renter
Primary cityprimary_citytext
City of the contact lives in.
Primary stateprimary_statetext
State the contact lives in.
Primary zipprimary_ziptext
Postal code the contact lives in.
Primary addressprimary_addresstext
Address the contact lives in.
Statusstatusnumber
The status of the lead. 0 - New, 1 - Client, 2 - Closed, 3 - Sphere, 4 - Active, 5 - Contract, 6 - Archived, 7 - ProspectOne of: 0 (New), 1 (Client), 2 (Closed), 3 (Sphere), 4 (Active), 5 (Contract), 6 (Archived), 7 (Prospect).
Sourcesourcetext
Top-level source the contact originated from.
Email optinemail_optinnumber
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 onphone_onnumber
Set to 1 if the contact should be contacted via phone; otherwise 0.One of: 0 (Off), 1 (On).
Text ontext_onnumber
Set to 1 if the contact should get automated texts; otherwise 0.One of: 0 (Off), 1 (On).
Ratingratingnumber
Value can be set to a range from 0-5, 0 being a poor quality contact, 5 being the best.
Capture methodcapture_methodtext
What method was used to capture the lead. This can be anything, but would be something like "Website Lead Capture" or "Dropbox".
Assigned agent idassigned_agent_idtext
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 idassigned_agent_external_idtext
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 datetcpa_optin_datedate 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 priceavg_pricenumber
Average price of viewed listings.
Avg bedsavg_bedsnumber
Average number of beds of viewed listings.
Avg bathsavg_bathsnumber
Average number of baths of viewed listings.
Is privateis_privatenumber
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 idactive_mls_idtext
If the lead is a seller, then this is the MLS ID of the listing they are selling.
Spouse first namespouse_first_nametext
First name of the contact's spouse.
Spouse last namespouse_last_nametext
Last name of the contact's spouse.
Spouse titlespouse_titletext
Title of the contact's spouse.
Spouse phonespouse_phonetext
Phone number of the contact's spouse.
Titletitletext
Title of the contact.
Birthdaybirthdaytext
Birthday of the contact.
Gendergendertext
Gender of the contact.
Poi addresspoi_addresstext
Address of the property of interest.
Poi citypoi_citytext
City of the property of interest.
Poi statepoi_statetext
State of the property of interest.
Poi zippoi_ziptext
Zip of the property of interest.
Second emailsecond_emailtext
Secondary email for the contact.
External vendor idexternal_vendor_idtext
External ID of the contact that can be set for tracking it in an external system.
Skip new notificationskip_new_notificationtrue/false
When set to true notifications will be skipped.
Last closing datelast_closing_datetext
The date of contact's last closing.

Outputs

dataobject
Bold Trail response data.
Example output
{
  "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
  }
}

On this page