Follow Up Boss
App · 20 actions
Manage real estate contacts, lead events, notes and tasks, with polling for new or updated records.
Actions
| Action | What it does |
|---|---|
| Create lead event | Create lead event. |
| Create note | Create note. |
| Create person | Create person. |
| Create task | Create task. |
| Delete note | Delete note. |
| Delete person | Delete person. |
| Delete task | Delete task. |
| Get event | Get event. |
| Get IDentity | Get IDentity. |
| Get note | Get note. |
| Get person | Get person. |
| Get task | Get task. |
| List events | List events. |
| List people | List people. |
| List stages | List stages. |
| List tasks | List tasks. |
| List users | List users. |
| Update note | Update note. |
| Update person | Update person. |
| Update task | Update task. |
Create lead event
Create lead event.
Inputs
- Source
sourcetext - The name of the lead source.
- System
systemtext - The name of the system used in providing leads.
- Type
typetext - 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
messagetext - A message from the user about this inquiry.
- Description
descriptiontext - Any additional information about this inquiry.
- Person
personobject - 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
propertyobject - Information about the property this event is related to.
- Property search
property_searchobject - 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
campaignobject - 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_titletext - 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_urltext - 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_referrertext - 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_durationnumber - 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_atdate - 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
dataobject- Returned value.
Example output
{
"data": {
"body": "example",
"created": "example",
"firstName": "example",
"id": 1,
"lastName": "example",
"name": "example",
"updated": "example"
}
}Create note
Create note.
Inputs
- Person ID
person_idnumberRequired - The ID of a person.
- Subject
subjecttext - Gives a note a title or subject.
- Body
bodytextRequired - The content of the note.
- Is html
is_htmltrue/false - If enabled, will render the HTML tags contained within the body on the Follow Up Boss user interface.
Outputs
dataobject- Returned value.
Example output
{
"data": {
"body": "example",
"created": "example",
"firstName": "example",
"id": 1,
"lastName": "example",
"name": "example",
"updated": "example"
}
}Create person
Create person.
Inputs
- Deduplicate
deduplicatetrue/false - Deduplicate.Default:
false. - Created at
created_atdate and time - Will set the creation time for the person, if wanting to create historical leads.
- First name
first_nametext - The first/given name of the person.
- Last name
last_nametext - The last/family name of the person.
- Stage
stagetext - The stage the person is in. (e.g., "Lead" or "Trash". See [stage API endpoint](ref:stages-get) for more options.)Default:
Lead. - Source
sourcetext - The source of the lead.
- Source url
source_urltext - This is a direct link to the information about a person at the lead provider.
- Contacted
contactedtrue/false - Whether the person has been contacted or not.
- Price
pricenumber - The price of the property of the person's first inquiry, or the estimated sell/buy price for this person.
- Assigned user
assigned_user_idnumber - ID of the agent assigned to this person.
- Assigned pond ID
assigned_pond_idnumber - ID of the pond assigned to this person.
- Assigned lender name
assigned_lender_nametext - Full name of the lender assigned to this person.
- Assigned lender ID
assigned_lender_idnumber - ID of the lender assigned to this person.
- Emails
emailslist - 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
phoneslist - 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
addresseslist - 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
tagslist - A list of tags applied to the person.
- Background
backgroundtext - Background information on the person. (Can be a multi-line string.)
- Collaborators
collaboratorslist - 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
customtext - 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_idnumber - ID of the timeframe to move (Refer to the /timeframes endpoint for valid values of timeframeId.)
Outputs
dataobject- Returned value.
Example output
{
"data": {
"body": "example",
"created": "example",
"firstName": "example",
"id": 1,
"lastName": "example",
"name": "example",
"updated": "example"
}
}Create task
Create task.
Inputs
- Person ID
person_idnumberRequired - The id of the person this task is related to.
- Assigned user
assigned_user_idnumberRequired - The id of the user to assign to this task. (Note: This is required if `assignedTo` is empty.)
- Name
nametextRequired - The name of the task.
- Type
typetext - 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_completedtrue/false - Sets whether the task is completed or not.
- Due date
due_datedate - Due date for this task in YYYY-MM-DD format.
- Due date time
due_date_timedate 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_beforenumber - 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
dataobject- Response.
Example output
{
"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
idnumberRequired - Id.
Outputs
dataobject- Returned value.
Example output
{
"data": {
"body": "example",
"created": "example",
"firstName": "example",
"id": 1,
"lastName": "example",
"name": "example",
"updated": "example"
}
}Delete person
Delete person.
Inputs
- Id
idnumberRequired - Id.
Outputs
dataobject- Returned value.
Example output
{
"data": {
"body": "example",
"created": "example",
"firstName": "example",
"id": 1,
"lastName": "example",
"name": "example",
"updated": "example"
}
}Delete task
Delete task.
Inputs
- Id
idnumberRequired - Id.
Outputs
dataobject- Returned value.
Example output
{
"data": {
"body": "example",
"created": "example",
"firstName": "example",
"id": 1,
"lastName": "example",
"name": "example",
"updated": "example"
}
}Get event
Get event.
Inputs
- Id
idnumberRequired - Id.
Outputs
dataobject- Response.
Example output
{
"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
dataobject- Returned value.
Example output
{
"data": {
"account": {
"domain": "example",
"id": 1,
"owner": {
"email": "example",
"name": "example"
}
},
"user": {
"email": "example",
"id": 1,
"name": "example"
}
}
}Get note
Get note.
Inputs
- Id
idnumberRequired - Id.
- Include threaded replies
include_threaded_repliestrue/false - Include threaded replies.
- Include reactions
include_reactionstrue/false - Include reactions.
Outputs
dataobject- Returned value.
Example output
{
"data": {
"body": "example",
"created": "example",
"firstName": "example",
"id": 1,
"lastName": "example",
"name": "example",
"updated": "example"
}
}Get person
Get person.
Inputs
- Id
idnumberRequired - Id.
- Fields
fieldstext - Fields.
Outputs
dataobject- Returned value.
Example output
{
"data": {
"body": "example",
"created": "example",
"firstName": "example",
"id": 1,
"lastName": "example",
"name": "example",
"updated": "example"
}
}Get task
Get task.
Inputs
- Id
idnumberRequired - Id.
Outputs
dataobject- Response.
Example output
{
"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
limitnumber - Limit.Default:
10. - Next
nexttext - Next.
- Offset
offsetnumber - Offset.Default:
0. - Person ID
person_idnumber - Person ID.
- Type
typetext - Type.
- Has property
has_propertytrue/false - Has property.
- Property address
property_addresstext - Property address.
Outputs
dataobject- Response.
Example output
{
"data": {
"_metadata": {
"collection": "example",
"limit": 1,
"next": "example",
"nextLink": "example",
"offset": 1,
"total": 1
},
"events": []
}
}List people
List people.
Inputs
- Id
idtext - Id.
- Sort
sorttext - Sort.Default:
created. - Limit
limitnumber - Limit.Default:
10. - Offset
offsetnumber - Offset.Default:
0. - Fields
fieldstext - Fields.
- Last activity after
last_activity_aftertext - Last activity after.
- Last activity before
last_activity_beforetext - Last activity before.
- Name
nametext - Name.
- First name
first_nametext - First name.
- Last name
last_nametext - Last name.
- Email
emailtext - Email.
- Phone
phonetext - Phone.
- Stage
stagetext - Stage.
- Source
sourcetext - Source.
- Assigned user
assigned_user_idnumber - Assigned user ID.
- Assigned pond ID
assigned_pond_idnumber - Assigned pond ID.
- Assigned lender name
assigned_lender_nametext - Assigned lender name.
- Assigned lender ID
assigned_lender_idnumber - Assigned lender ID.
- Contacted
contactedtrue/false - Contacted.
- Price above
price_abovenumber - Price above.
- Price below
price_belownumber - Price below.
- Smart list ID
smart_list_idnumber - Smart list ID.
- Include trash
include_trashtrue/false - Include trash.Default:
false. - Include unclaimed
include_unclaimedtrue/false - Include unclaimed.Default:
false. - Tags
tagstext - Tags.
- Custom
customtext - Custom.
- Next
nexttext - Next.
Outputs
dataobject- Returned value.
Example output
{
"data": {
"_metadata": {},
"people": []
}
}List stages
List stages.
Inputs
- Limit
limitnumber - Limit.Default:
10. - Offset
offsetnumber - Offset.Default:
0. - Sort
sorttext - Sort.Default:
orderWeight. - Next
nexttext - Next.
Outputs
dataobject- Response.
Example output
{
"data": {
"_metadata": {
"collection": "example",
"limit": 1,
"offset": 1,
"total": 1
},
"stages": []
}
}List tasks
List tasks.
Inputs
- Person ID
person_idnumber - Person ID.
- Assigned user
assigned_user_idnumber - Assigned user ID.
- Name
nametext - Name.
- Type
typetext - Type.
- Is completed
is_completedtrue/false - Is completed.
- Due
duetext - Due.
- Due start
due_startdate and time - Due start.
- Due end
due_enddate and time - Due end.
- Next
nexttext - Next.
Outputs
dataobject- Returned value.
Example output
{
"data": {
"_metadata": {},
"tasks": []
}
}List users
List users.
Inputs
- Limit
limitnumber - Limit.Default:
10. - Offset
offsetnumber - Offset.Default:
0. - Sort
sorttext - Sort.
- Role
roletext - Role.
- Name
nametext - Name.
- Email
emailtext - Email.
- Fields
fieldstext - Fields.
- Include deleted
include_deletedtrue/false - Include deleted.Default:
false. - Next
nexttext - Next.
Outputs
dataobject- Returned value.
Example output
{
"data": {
"_metadata": {},
"users": []
}
}Update note
Update note.
Inputs
- Id
idnumberRequired - Id.
- Person ID
person_idnumber - The ID of a person associated with this note.
- Subject
subjecttext - You can give a note a title or subject using this field.
- Body
bodytext - The content of the note.
- Is html
is_htmltrue/false - If enabled, will render the HTML tags contained within the body on the Follow Up Boss user interface.
Outputs
dataobject- Response.
Example output
{
"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
idnumberRequired - Id.
- Merge tags
merge_tagstrue/false - Merge tags.Default:
false. - First name
first_nametext - The first/given name of the person.
- Last name
last_nametext - The last/family name of the person.
- Stage
stagetext - The stage the person is in. (e.g., "Lead" or "Trash". See [stage API endpoint](ref:stages-get) for more options.)
- Contacted
contactedtrue/false - Whether the person has been contacted. (**Note**: Changing the `contacted` field to `true` will pause action plans.)
- Price
pricenumber - The price of the property of the person's first inquiry, or the estimated sell/buy price for this person.
- Assigned user
assigned_user_idnumber - ID of the agent assigned to this person.
- Assigned pond ID
assigned_pond_idnumber - ID of the pond assigned to this person.
- Assigned lender name
assigned_lender_nametext - Full name of the lender assigned to this person.
- Assigned lender ID
assigned_lender_idnumber - ID of the lender assigned to this person.
- Emails
emailslist - A list of email addresses associated with the person.
- Phones
phoneslist - A list of phone numbers associated with the person.
- Addresses
addresseslist - 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
tagslist - 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
backgroundtext - Background information on the person. (Can be a multi-line string.)
- Custom
customtext - 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_idnumber - ID of the timeframe to move (Refer to the /timeframes endpoint for valid values of timeframeId.)
Outputs
dataobject- Returned value.
Example output
{
"data": {
"body": "example",
"created": "example",
"firstName": "example",
"id": 1,
"lastName": "example",
"name": "example",
"updated": "example"
}
}Update task
Update task.
Inputs
- Id
idnumberRequired - Id.
- Person ID
person_idnumber - The id of the person this task is related to.
- Assigned user
assigned_user_idnumber - The id of the user to assign to this task.
- Name
nametext - The name of the task.
- Type
typetext - 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_completedtrue/false - Sets whether the task is completed or not.
Outputs
dataobject- Returned value.
Example output
{
"data": {
"body": "example",
"created": "example",
"firstName": "example",
"id": 1,
"lastName": "example",
"name": "example",
"updated": "example"
}
}