Follow Up Boss

App · 20 actions

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

Actions

ActionWhat it does
Create lead eventCreate lead event.
Create noteCreate note.
Create personCreate person.
Create taskCreate task.
Delete noteDelete note.
Delete personDelete person.
Delete taskDelete task.
Get eventGet event.
Get IDentityGet IDentity.
Get noteGet note.
Get personGet person.
Get taskGet task.
List eventsList events.
List peopleList people.
List stagesList stages.
List tasksList tasks.
List usersList users.
Update noteUpdate note.
Update personUpdate person.
Update taskUpdate task.

Create lead event

Create lead event.

Inputs

Sourcesourcetext
The name of the lead source.
Systemsystemtext
The name of the system used in providing leads.
Typetypetext
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.
Messagemessagetext
A message from the user about this inquiry.
Descriptiondescriptiontext
Any additional information about this inquiry.
Personpersonobject
Information about the lead who triggered this event. Follow Up Boss will automatically de-duplicate people based on their phone number or email address.
Propertypropertyobject
Information about the property this event is related to.
Property searchproperty_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.
Campaigncampaignobject
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 titlepage_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 urlpage_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 referrerpage_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 durationpage_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 atoccurred_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 IDperson_idnumberRequired
The ID of a person.
Subjectsubjecttext
Gives a note a title or subject.
BodybodytextRequired
The content of the note.
Is htmlis_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

Deduplicatededuplicatetrue/false
Deduplicate.Default: false.
Created atcreated_atdate and time
Will set the creation time for the person, if wanting to create historical leads.
First namefirst_nametext
The first/given name of the person.
Last namelast_nametext
The last/family name of the person.
Stagestagetext
The stage the person is in. (e.g., "Lead" or "Trash". See [stage API endpoint](ref:stages-get) for more options.)Default: Lead.
Sourcesourcetext
The source of the lead.
Source urlsource_urltext
This is a direct link to the information about a person at the lead provider.
Contactedcontactedtrue/false
Whether the person has been contacted or not.
Pricepricenumber
The price of the property of the person's first inquiry, or the estimated sell/buy price for this person.
Assigned userassigned_user_idnumber
ID of the agent assigned to this person.
Assigned pond IDassigned_pond_idnumber
ID of the pond assigned to this person.
Assigned lender nameassigned_lender_nametext
Full name of the lender assigned to this person.
Assigned lender IDassigned_lender_idnumber
ID of the lender assigned to this person.
Emailsemailslist
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.)
Phonesphoneslist
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.)
Addressesaddresseslist
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).
Tagstagslist
A list of tags applied to the person.
Backgroundbackgroundtext
Background information on the person. (Can be a multi-line string.)
Collaboratorscollaboratorslist
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.
Customcustomtext
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 IDtimeframe_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 IDperson_idnumberRequired
The id of the person this task is related to.
Assigned userassigned_user_idnumberRequired
The id of the user to assign to this task. (Note: This is required if `assignedTo` is empty.)
NamenametextRequired
The name of the task.
Typetypetext
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 completedis_completedtrue/false
Sets whether the task is completed or not.
Due datedue_datedate
Due date for this task in YYYY-MM-DD format.
Due date timedue_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 beforeremind_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

IdidnumberRequired
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

IdidnumberRequired
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

IdidnumberRequired
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

IdidnumberRequired
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

IdidnumberRequired
Id.
Include threaded repliesinclude_threaded_repliestrue/false
Include threaded replies.
Include reactionsinclude_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

IdidnumberRequired
Id.
Fieldsfieldstext
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

IdidnumberRequired
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

Limitlimitnumber
Limit.Default: 10.
Nextnexttext
Next.
Offsetoffsetnumber
Offset.Default: 0.
Person IDperson_idnumber
Person ID.
Typetypetext
Type.
Has propertyhas_propertytrue/false
Has property.
Property addressproperty_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

Ididtext
Id.
Sortsorttext
Sort.Default: created.
Limitlimitnumber
Limit.Default: 10.
Offsetoffsetnumber
Offset.Default: 0.
Fieldsfieldstext
Fields.
Last activity afterlast_activity_aftertext
Last activity after.
Last activity beforelast_activity_beforetext
Last activity before.
Namenametext
Name.
First namefirst_nametext
First name.
Last namelast_nametext
Last name.
Emailemailtext
Email.
Phonephonetext
Phone.
Stagestagetext
Stage.
Sourcesourcetext
Source.
Assigned userassigned_user_idnumber
Assigned user ID.
Assigned pond IDassigned_pond_idnumber
Assigned pond ID.
Assigned lender nameassigned_lender_nametext
Assigned lender name.
Assigned lender IDassigned_lender_idnumber
Assigned lender ID.
Contactedcontactedtrue/false
Contacted.
Price aboveprice_abovenumber
Price above.
Price belowprice_belownumber
Price below.
Smart list IDsmart_list_idnumber
Smart list ID.
Include trashinclude_trashtrue/false
Include trash.Default: false.
Include unclaimedinclude_unclaimedtrue/false
Include unclaimed.Default: false.
Tagstagstext
Tags.
Customcustomtext
Custom.
Nextnexttext
Next.

Outputs

dataobject
Returned value.
Example output
{
  "data": {
    "_metadata": {},
    "people": []
  }
}

List stages

List stages.

Inputs

Limitlimitnumber
Limit.Default: 10.
Offsetoffsetnumber
Offset.Default: 0.
Sortsorttext
Sort.Default: orderWeight.
Nextnexttext
Next.

Outputs

dataobject
Response.
Example output
{
  "data": {
    "_metadata": {
      "collection": "example",
      "limit": 1,
      "offset": 1,
      "total": 1
    },
    "stages": []
  }
}

List tasks

List tasks.

Inputs

Person IDperson_idnumber
Person ID.
Assigned userassigned_user_idnumber
Assigned user ID.
Namenametext
Name.
Typetypetext
Type.
Is completedis_completedtrue/false
Is completed.
Dueduetext
Due.
Due startdue_startdate and time
Due start.
Due enddue_enddate and time
Due end.
Nextnexttext
Next.

Outputs

dataobject
Returned value.
Example output
{
  "data": {
    "_metadata": {},
    "tasks": []
  }
}

List users

List users.

Inputs

Limitlimitnumber
Limit.Default: 10.
Offsetoffsetnumber
Offset.Default: 0.
Sortsorttext
Sort.
Roleroletext
Role.
Namenametext
Name.
Emailemailtext
Email.
Fieldsfieldstext
Fields.
Include deletedinclude_deletedtrue/false
Include deleted.Default: false.
Nextnexttext
Next.

Outputs

dataobject
Returned value.
Example output
{
  "data": {
    "_metadata": {},
    "users": []
  }
}

Update note

Update note.

Inputs

IdidnumberRequired
Id.
Person IDperson_idnumber
The ID of a person associated with this note.
Subjectsubjecttext
You can give a note a title or subject using this field.
Bodybodytext
The content of the note.
Is htmlis_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

IdidnumberRequired
Id.
Merge tagsmerge_tagstrue/false
Merge tags.Default: false.
First namefirst_nametext
The first/given name of the person.
Last namelast_nametext
The last/family name of the person.
Stagestagetext
The stage the person is in. (e.g., "Lead" or "Trash". See [stage API endpoint](ref:stages-get) for more options.)
Contactedcontactedtrue/false
Whether the person has been contacted. (**Note**: Changing the `contacted` field to `true` will pause action plans.)
Pricepricenumber
The price of the property of the person's first inquiry, or the estimated sell/buy price for this person.
Assigned userassigned_user_idnumber
ID of the agent assigned to this person.
Assigned pond IDassigned_pond_idnumber
ID of the pond assigned to this person.
Assigned lender nameassigned_lender_nametext
Full name of the lender assigned to this person.
Assigned lender IDassigned_lender_idnumber
ID of the lender assigned to this person.
Emailsemailslist
A list of email addresses associated with the person.
Phonesphoneslist
A list of phone numbers associated with the person.
Addressesaddresseslist
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).
Tagstagslist
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.)
Backgroundbackgroundtext
Background information on the person. (Can be a multi-line string.)
Customcustomtext
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 IDtimeframe_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

IdidnumberRequired
Id.
Person IDperson_idnumber
The id of the person this task is related to.
Assigned userassigned_user_idnumber
The id of the user to assign to this task.
Namenametext
The name of the task.
Typetypetext
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 completedis_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"
  }
}

On this page