The Follow Up Boss connector lets your AI agent act in each user's Follow Up Boss account. Each user connects their own Follow Up Boss API key once, and Scalekit sends it with every call, so your agent never handles credentials. It comes with 85 tools.
- Tools
- 85
- What they doRead · write · destructive
- 58 · 27 · 058 read27 write0 destructive
- Users sign in with
- API key
Setup
Install the SDK
Terminal window npm install @scalekit-sdk/node dotenvTerminal window pip install scalekit-sdk-python python-dotenvSet your credentials
Add your Scalekit credentials to your
.envfile. Find values in app.scalekit.com > Developers > API Credentials..env SCALEKIT_ENVIRONMENT_URL=<your-environment-url>SCALEKIT_CLIENT_ID=<your-client-id>SCALEKIT_CLIENT_SECRET=<your-client-secret>Create the Follow Up Boss connection
In AgentKit > Connections, create a Follow Up Boss connection. The name you give it is the
connection_nameyour code passes. See Configure connections.
Tools
Pass the exact name toexecute_toolfollowupboss_action_plan_people_listList action plans applied to a person, or people on an action plan, in Follow Up Boss.Read-onlyList Action Plan Assignments
List action plans applied to a person, or people on an action plan, in Follow Up Boss. Returns assignments with their id, person, action plan and status (Running or Paused). Use it to find an assignment ID before pausing or resuming it with followupboss_action_plan_person_update.
Inputs
action_plan_idinteger- Return people on this action plan ID.
limitinteger- Maximum number of records to return, from 1 to 100. Follow Up Boss returns 10 when this is omitted.
offsetinteger- Number of records to skip before returning results, used for paging (e.g. 25 to get the second page of 25). Results are newest first by default.
person_idinteger- Return action plans applied to this person ID.
followupboss_action_plans_listList action plans (automated follow-up sequences) in Follow Up Boss.Read-onlyList Action Plans
List action plans (automated follow-up sequences) in Follow Up Boss. Returns action plans with id, name and status. Use it to find an action plan ID before applying it with followupboss_action_plan_person_apply.
Inputs
idsstring- Comma-separated action plan IDs.
limitinteger- Maximum number of records to return, from 1 to 100. Follow Up Boss returns 10 when this is omitted.
namesarray- Action plan names to match exactly; each is sent as a names[] parameter. Example: ["New Buyer Lead"]
offsetinteger- Number of records to skip before returning results, used for paging (e.g. 25 to get the second page of 25). Results are newest first by default.
sortstring- Field to sort by: id, name. Prefix with a minus sign for descending order (e.g. -id).
statusstring- Status filter: Active, Deleted, or Active,Deleted for both.one of
ActiveDeletedActive,Deleted
followupboss_appointment_getGet one appointment in Follow Up Boss by ID.Read-onlyGet Appointment
Get one appointment in Follow Up Boss by ID. Returns its title, start and end, location, description, invitees, type and outcome. Use it when you have the appointment ID. Use followupboss_appointments_list to find appointments.
Inputs
idintegerrequired- Numeric ID of the appointment.
followupboss_appointment_outcome_getGet one appointment outcome in Follow Up Boss by ID.Read-onlyGet Appointment Outcome
Get one appointment outcome in Follow Up Boss by ID. Returns the outcome's name and order. Use it when you have the outcome ID. Use followupboss_appointment_outcomes_list to see all outcomes.
Inputs
idintegerrequired- Numeric ID of the appointment outcome.
followupboss_appointment_outcomes_listList appointment outcomes (such as Met or No Show) in the Follow Up Boss account.Read-onlyList Appointment Outcomes
List appointment outcomes (such as Met or No Show) in the Follow Up Boss account. Returns appointment outcomes with id, name and order. Use it to get an outcome_id for followupboss_appointment_update.
Inputs
limitinteger- Maximum number of records to return, from 1 to 100. Follow Up Boss returns 10 when this is omitted.
offsetinteger- Number of records to skip before returning results, used for paging (e.g. 25 to get the second page of 25). Results are newest first by default.
sortstring- Field to sort by: orderWeight, id, name. Prefix with a minus sign for descending order (e.g. -orderWeight). Defaults to orderWeight.
followupboss_appointment_type_getGet one appointment type in Follow Up Boss by ID.Read-onlyGet Appointment Type
Get one appointment type in Follow Up Boss by ID. Returns the type's name and order. Use it when you have the type ID. Use followupboss_appointment_types_list to see all types.
Inputs
idintegerrequired- Numeric ID of the appointment type.
followupboss_appointment_types_listList appointment types (such as Showing or Listing Appointment) in the Follow Up Boss account.Read-onlyList Appointment Types
List appointment types (such as Showing or Listing Appointment) in the Follow Up Boss account. Returns appointment types with id, name and order. Use it to get a type_id for followupboss_appointment_create.
Inputs
limitinteger- Maximum number of records to return, from 1 to 100. Follow Up Boss returns 10 when this is omitted.
offsetinteger- Number of records to skip before returning results, used for paging (e.g. 25 to get the second page of 25). Results are newest first by default.
sortstring- Field to sort by: orderWeight, id, name. Prefix with a minus sign for descending order (e.g. -orderWeight). Defaults to orderWeight.
followupboss_appointments_listList appointments in Follow Up Boss, filtered by person, user or a date range.Read-onlyList Appointments
List appointments in Follow Up Boss, filtered by person, user or a date range. Returns a page of appointments with title, start and end, location, invitees, type and outcome. Use it to see a calendar or a contact's appointments. Use followupboss_appointment_get for one appointment by ID. start and end must be sent together.
Inputs
endstring- End of the date range to search (ISO 8601). Must be used with start.
limitinteger- Maximum number of records to return, from 1 to 100. Follow Up Boss returns 10 when this is omitted.
offsetinteger- Number of records to skip before returning results, used for paging (e.g. 25 to get the second page of 25). Results are newest first by default.
person_idstring- Return appointments for this person ID, or a comma-separated list of person IDs.
startstring- Start of the date range to search (ISO 8601). Must be used with end.
user_idinteger- Return appointments for this user ID.
followupboss_automation_getGet one automation in Follow Up Boss by ID.Read-onlyGet Automation
Get one automation in Follow Up Boss by ID. Returns the automation's name, status, triggers and steps. Use it when you have the automation ID. Use followupboss_automations_list to find automations.
Inputs
idintegerrequired- Numeric ID of the automation.
followupboss_automation_people_listList pairings of automations and the people they have run, or will run, on in Follow Up Boss.Read-onlyList Automation Runs
List pairings of automations and the people they have run, or will run, on in Follow Up Boss. Returns pairings with id, automation, person and status (Initial, Running, Paused or Completed). Use it to find a pairing ID before pausing or resuming it with followupboss_automation_person_update.
Inputs
automation_idinteger- Return pairings for this automation ID.
limitinteger- Maximum number of records to return, from 1 to 100. Follow Up Boss returns 10 when this is omitted.
offsetinteger- Number of records to skip before returning results, used for paging (e.g. 25 to get the second page of 25). Results are newest first by default.
person_idinteger- Return pairings for this person ID.
statusstring- Return pairings with this status.one of
InitialRunningPausedCompleted
followupboss_automation_person_getGet one automation-person pairing in Follow Up Boss by ID.Read-onlyGet Automation Run
Get one automation-person pairing in Follow Up Boss by ID. Returns the pairing's automation, person and status. Use it when you have the pairing ID. Use followupboss_automation_people_list to find pairings.
Inputs
idintegerrequired- Numeric ID of the automation-person pairing.
followupboss_automations_listList automations in Follow Up Boss.Read-onlyList Automations
List automations in Follow Up Boss. Returns automations with id, name, status and trigger details. Use it to find an automation ID, for example one with a manual trigger to run with followupboss_automation_person_trigger.
Inputs
enabled_onlyboolean- Set to true to return only enabled automations.
limitinteger- Maximum number of records to return, from 1 to 100. Follow Up Boss returns 10 when this is omitted.
manual_onlyboolean- Set to true to return only automations with a manual trigger.
offsetinteger- Number of records to skip before returning results, used for paging (e.g. 25 to get the second page of 25). Results are newest first by default.
statusstring- Return automations with this status.one of
ActiveDisabledDeleted
followupboss_call_getGet one logged call in Follow Up Boss by ID.Read-onlyGet Call
Get one logged call in Follow Up Boss by ID. Returns the call's direction, numbers, outcome, duration, note, person and user. Use it when you have the call ID. Use followupboss_calls_list to find calls.
Inputs
idintegerrequired- Numeric ID of the call.
followupboss_calls_listList logged phone calls in Follow Up Boss, filtered by person or phone number.Read-onlyList Calls
List logged phone calls in Follow Up Boss, filtered by person or phone number. Returns a page of calls with direction, phone numbers, outcome, duration, note and user. Use it to review call history. Use followupboss_call_get for one call by ID.
Inputs
from_numberstring- Return calls made from this number.
limitinteger- Maximum number of records to return, from 1 to 100. Follow Up Boss returns 10 when this is omitted.
offsetinteger- Number of records to skip before returning results, used for paging (e.g. 25 to get the second page of 25). Results are newest first by default.
person_idinteger- Return only calls with this person ID.
phonestring- Return calls with this phone number, incoming or outgoing.
to_numberstring- Return calls made to this number.
followupboss_current_user_getGet the Follow Up Boss user whose API key the connection uses.Read-onlyGet Current User
Get the Follow Up Boss user whose API key the connection uses. Returns the user's id, name, email, role and account details. Use it to check who the agent is acting as. Use followupboss_users_list for other users and followupboss_identity_get for account details.
Inputs
This tool takes no inputs.
followupboss_custom_field_getGet one people custom field definition in Follow Up Boss by ID.Read-onlyGet Custom Field
Get one people custom field definition in Follow Up Boss by ID. Returns the field's label, name, type, choices and display settings. Use it when you have the field ID. Use followupboss_custom_fields_list to see all fields.
Inputs
idintegerrequired- Numeric ID of the custom field.
followupboss_custom_fields_listList the custom fields defined for people in the Follow Up Boss account.Read-onlyList Custom Fields
List the custom fields defined for people in the Follow Up Boss account. Returns custom fields with id, label, name (the customXxx key), type and dropdown choices. Use it to learn the keys to pass in custom_fields on followupboss_person_create and followupboss_person_update. Use followupboss_deal_custom_fields_list for deal fields.
Inputs
labelstring- Return the custom field with this label.
limitinteger- Maximum number of records to return, from 1 to 100. Follow Up Boss returns 10 when this is omitted.
offsetinteger- Number of records to skip before returning results, used for paging (e.g. 25 to get the second page of 25). Results are newest first by default.
sortstring- Field to sort by: id, name or orderWeight. Prefix with a minus sign for descending order.one of
idnameorderWeight-id-name-orderWeight
followupboss_deal_custom_field_getGet one deal custom field definition in Follow Up Boss by ID.Read-onlyGet Deal Custom Field
Get one deal custom field definition in Follow Up Boss by ID. Returns the field's label, name, type, choices and settings. Use it when you have the field ID. Use followupboss_deal_custom_fields_list to see all deal fields.
Inputs
idintegerrequired- Numeric ID of the deal custom field.
followupboss_deal_custom_fields_listList the custom fields defined for deals in the Follow Up Boss account.Read-onlyList Deal Custom Fields
List the custom fields defined for deals in the Follow Up Boss account. Returns deal custom fields with id, label, name, type and dropdown choices. Use it to understand custom data on deals. Use followupboss_custom_fields_list for people fields.
Inputs
labelstring- Return the deal custom field with this label.
limitinteger- Maximum number of records to return, from 1 to 100. Follow Up Boss returns 10 when this is omitted.
offsetinteger- Number of records to skip before returning results, used for paging (e.g. 25 to get the second page of 25). Results are newest first by default.
sortstring- Field to sort by: id, name or orderWeight. Prefix with a minus sign for descending order.one of
idnameorderWeight-id-name-orderWeight
followupboss_deal_getGet one deal in Follow Up Boss by ID.Read-onlyGet Deal
Get one deal in Follow Up Boss by ID. Returns the deal's name, stage, pipeline, price, people, users, commissions and dates. Use it when you have the deal ID. Use followupboss_deals_list to find deals.
Inputs
idintegerrequired- Numeric ID of the deal.
followupboss_deals_listList deals in Follow Up Boss, filtered by pipeline, user, person or status.Read-onlyList Deals
List deals in Follow Up Boss, filtered by pipeline, user, person or status. Returns deals with name, stage, pipeline, price, people, users, commission and key dates. Use it to review a pipeline or a client's deals. Use followupboss_deal_get for one deal by ID.
Inputs
include_archivedinteger- Set to 1 to include archived deals.one of
01 include_deletedinteger- Set to 1 to include deleted deals.one of
01 limitinteger- Maximum number of records to return, from 1 to 100. Follow Up Boss returns 10 when this is omitted.
offsetinteger- Number of records to skip before returning results, used for paging (e.g. 25 to get the second page of 25). Results are newest first by default.
person_idinteger- Return deals for this person ID.
pipeline_idinteger- Return deals in this pipeline ID. List pipelines with followupboss_pipelines_list.
statusstring- Return only deals with this status.one of
ActiveArchivedDeleted user_idinteger- Return deals for this user ID.
followupboss_email_campaigns_listList email marketing campaigns recorded in Follow Up Boss by connected email marketing tools.Read-onlyList Email Marketing Campaigns
List email marketing campaigns recorded in Follow Up Boss by connected email marketing tools. Returns campaigns with id, name, subject, origin and originId. Use it to review campaigns. Use followupboss_email_events_list for per-person opens, clicks and bounces.
Inputs
limitinteger- Maximum number of records to return, from 1 to 100. Follow Up Boss returns 10 when this is omitted.
offsetinteger- Number of records to skip before returning results, used for paging (e.g. 25 to get the second page of 25). Results are newest first by default.
originstring- Return campaigns from this originating system, e.g. Mailchimp.
origin_idstring- Return the campaign with this ID in the originating system.
followupboss_email_events_listList email marketing events (deliveries, opens, clicks, bounces, unsubscribes, spam reports) recorded in Follow Up Boss.Read-onlyList Email Marketing Events
List email marketing events (deliveries, opens, clicks, bounces, unsubscribes, spam reports) recorded in Follow Up Boss. Returns events with type, person, campaign and timestamp. Use it to see how a contact engaged with marketing email. Use followupboss_email_campaigns_list for the campaigns themselves.
Inputs
limitinteger- Maximum number of records to return, from 1 to 100. Follow Up Boss returns 10 when this is omitted.
offsetinteger- Number of records to skip before returning results, used for paging (e.g. 25 to get the second page of 25). Results are newest first by default.
person_idinteger- Return email marketing events for this person ID.
typestring- Event type to return.one of
deliveredopenclickbouncedsoft-bouncehard-bounceunsubscribespamreport updated_afterstring- Return events created or updated after this time (ISO 8601).
followupboss_email_template_getGet one email template in Follow Up Boss by ID, optionally with merge fields filled in for a person.Read-onlyGet Email Template
Get one email template in Follow Up Boss by ID, optionally with merge fields filled in for a person. Returns the template's name, subject and HTML body. Use it to read or preview a template. Use followupboss_email_template_merge to merge it for several recipients.
Inputs
idintegerrequired- Numeric ID of the email template.
merge_person_idinteger- Person ID to fill merge fields (such as %contact_name%) with, together with the current user's details.
followupboss_email_templates_listList email templates in Follow Up Boss.Read-onlyList Email Templates
List email templates in Follow Up Boss. Returns templates with id, name, subject and sharing setting. Use it to find a template ID. Use followupboss_email_template_get for the full body, optionally merged for a person.
Inputs
limitinteger- Maximum number of records to return, from 1 to 100. Follow Up Boss returns 10 when this is omitted.
offsetinteger- Number of records to skip before returning results, used for paging (e.g. 25 to get the second page of 25). Results are newest first by default.
followupboss_event_getGet one lead event in Follow Up Boss by ID.Read-onlyGet Event
Get one lead event in Follow Up Boss by ID. Returns the event's type, source, message, description, person and property details. Use it when you have the event ID. Use followupboss_events_list to find events for a person.
Inputs
idintegerrequired- Numeric ID of the event.
followupboss_events_listList lead events (inquiries, registrations, property views and other activity) in Follow Up Boss, optionally filtered by person, event type or property.Read-onlyList Events
List lead events (inquiries, registrations, property views and other activity) in Follow Up Boss, optionally filtered by person, event type or property. Returns a page of events with type, source, message, person and property details, plus _metadata with total and the next cursor. Use it to review a lead's activity history. Use followupboss_event_get for one event by ID.
Inputs
has_propertyboolean- true returns only events linked to a property; false only those without one.
limitinteger- Maximum number of records to return, from 1 to 100. Follow Up Boss returns 10 when this is omitted.
nextstring- Pagination cursor. Pass the _metadata.next value from the previous response to get the following page; this is faster than offset for deep paging.
offsetinteger- Number of records to skip before returning results, used for paging (e.g. 25 to get the second page of 25). Results are newest first by default.
person_idinteger- Return only events for this person ID.
property_addressstring- Partial match on the event's property address.
typestring- Comma-separated event types to include, e.g. Registration,Property Inquiry.
followupboss_group_getGet one user group in Follow Up Boss by ID.Read-onlyGet Group
Get one user group in Follow Up Boss by ID. Returns the group's name, type and members. Use it when you have the group ID. Use followupboss_groups_list to see all groups.
Inputs
idintegerrequired- Numeric ID of the group.
followupboss_groups_listList user groups (used for lead routing) in the Follow Up Boss account.Read-onlyList Groups
List user groups (used for lead routing) in the Follow Up Boss account. Returns groups with id, name, type and member users. Use it to see how users are grouped. Use followupboss_groups_round_robin_list when you also need round-robin distribution data.
Inputs
limitinteger- Maximum number of records to return, from 1 to 100. Follow Up Boss returns 10 when this is omitted.
offsetinteger- Number of records to skip before returning results, used for paging (e.g. 25 to get the second page of 25). Results are newest first by default.
sortstring- Field to sort by: id or name. Prefix with a minus sign for descending order.one of
idname-id-name typestring- Agent groups contain admins and agents; Lender groups contain lenders.one of
AgentLender
followupboss_groups_round_robin_listList user groups in Follow Up Boss together with their round-robin lead distribution data.Read-onlyList Groups with Round Robin
List user groups in Follow Up Boss together with their round-robin lead distribution data. Returns groups with members and round-robin settings and state. Use it to see who is next in a lead rotation. Use followupboss_groups_list for plain group membership.
Inputs
limitinteger- Maximum number of records to return, from 1 to 100. Follow Up Boss returns 10 when this is omitted.
offsetinteger- Number of records to skip before returning results, used for paging (e.g. 25 to get the second page of 25). Results are newest first by default.
sortstring- Field to sort by: id or name. Prefix with a minus sign for descending order.one of
idname-id-name typestring- Agent groups contain admins and agents; Lender groups contain lenders.one of
AgentLender
followupboss_identity_getGet identity and authentication details for the connected Follow Up Boss account.Read-onlyGet Identity
Get identity and authentication details for the connected Follow Up Boss account. Returns the account and the authenticated user (id, name, email, role). Use it to confirm which account the connection belongs to. Use followupboss_current_user_get for the user's full profile.
Inputs
This tool takes no inputs.
followupboss_note_getGet one note in Follow Up Boss by ID, optionally with its threaded replies and reactions.Read-onlyGet Note
Get one note in Follow Up Boss by ID, optionally with its threaded replies and reactions. Returns the note's subject, body, person, author and timestamps. Use it to read a note you have the ID for. Notes are created with followupboss_note_create.
Inputs
idintegerrequired- Numeric ID of the note.
include_reactionsboolean- Set to true to include reactions left on the note (and on its replies, if those are included).
include_threaded_repliesboolean- Set to true to include replies posted on the note. Reply bodies may contain HTML.
followupboss_people_listSearch people (leads and contacts) in Follow Up Boss by name, email, phone, stage, source, assigned agent, tags, price, smart list or activity date; all filters combine with AND.Read-onlyList People
Search people (leads and contacts) in Follow Up Boss by name, email, phone, stage, source, assigned agent, tags, price, smart list or activity date; all filters combine with AND. Returns a page of person records (id, name, stage, source, assigned agent, emails, phones, tags) plus _metadata with total and the next cursor. Use it to browse or find people. Use followupboss_person_get when you have the ID, and followupboss_person_duplicate_check to test whether an email or phone already exists.
Inputs
assigned_lender_idinteger- Return people assigned to this lender user ID.
assigned_lender_namestring- Return people assigned to the lender with this full name.
assigned_pond_idinteger- Return people in this pond ID.
assigned_tostring- Return people assigned to the agent with this full name.
assigned_user_idinteger- Return people assigned to this user ID.
contactedboolean- true returns only people who have been contacted; false only those who have not.
emailstring- Exact email address to look up.
fieldsstring- Comma-separated fields to return instead of the default set. Use allFields for everything or allCustom for all custom fields; custom fields are prefixed with custom. The id is always returned.
first_namestring- Partial match on first name.
idsstring- Comma-separated person IDs to fetch several people at once.
include_trashboolean- Set to true to include people in the Trash stage, which are left out by default.
include_unclaimedboolean- Set to true to include unclaimed leads offered to the current user.
last_activity_afterstring- Return people whose last activity is after this date and time (YYYY-MM-DD HH:MM:SS, UTC).
last_activity_beforestring- Return people whose last activity is before this date and time (YYYY-MM-DD HH:MM:SS, UTC).
last_namestring- Partial match on last name.
limitinteger- Maximum number of records to return, from 1 to 100. Follow Up Boss returns 10 when this is omitted.
namestring- Partial match on full name (e.g. drew also matches Andrew).
nextstring- Pagination cursor. Pass the _metadata.next value from the previous response to get the following page; this is faster than offset for deep paging.
offsetinteger- Number of records to skip before returning results, used for paging (e.g. 25 to get the second page of 25). Results are newest first by default.
phonestring- Phone number to look up.
price_aboveinteger- Return people whose price is above this value.
price_belowinteger- Return people whose price is below this value.
smart_list_idinteger- Return people matching this smart list ID. List smart lists with followupboss_smart_lists_list.
sortstring- Field to sort by: created, id, updated, name, firstName, lastName, price, stage, lastActivity, lastCommunication, nextTask. Prefix with a minus sign for descending order (e.g. -created). Custom field names also work. Defaults to created.
sourcestring- Return people from this lead source, e.g. Zillow.
stagestring- Return people in this stage, e.g. Lead or Past Client. List stage names with followupboss_stages_list.
tagsstring- Comma-separated tags; people with any of them are returned (e.g. Buyer,Zillow matches either).
followupboss_person_duplicate_checkCheck whether a person with a given email address or phone number already exists in Follow Up Boss.Read-onlyCheck Duplicate Person
Check whether a person with a given email address or phone number already exists in Follow Up Boss. Returns the matching person's details when one exists. Use it before creating a contact to avoid duplicates. Use followupboss_people_list for broader searches. Provide email, phone or both.
Inputs
emailstring- Email address to check. Provide this, phone, or both.
phonestring- Phone number to check. Provide this, email, or both.
followupboss_person_getGet one person (lead or contact) in Follow Up Boss by ID.Read-onlyGet Person
Get one person (lead or contact) in Follow Up Boss by ID. Returns the person record: name, stage, source, assigned agent and lender, emails, phones, addresses, tags, price and the fields you request. Use it when you have the person's ID. Use followupboss_people_list to find a person by name, email or other filters.
Inputs
idintegerrequired- Numeric ID of the person.
fieldsstring- Comma-separated fields to return instead of the default set. Use allFields for everything, allCustom for all custom fields, or include relationships to embed related contacts.
followupboss_person_relationship_getGet one relationship (a contact related to a person) in Follow Up Boss by ID.Read-onlyGet Person Relationship
Get one relationship (a contact related to a person) in Follow Up Boss by ID. Returns its name, type, emails, phones, addresses and the person it belongs to. Use it when you have the relationship ID. Use followupboss_person_relationships_list to find them.
Inputs
idintegerrequired- Numeric ID of the relationship.
followupboss_person_relationships_listList relationships (spouses, partners, family and other related contacts) attached to people in Follow Up Boss.Read-onlyList Person Relationships
List relationships (spouses, partners, family and other related contacts) attached to people in Follow Up Boss. Returns relationships with name, type, contact details and the person they belong to. Use it to see who is related to a contact. Use followupboss_person_relationship_get for one relationship by ID.
Inputs
first_namestring- Partial match on first name.
last_namestring- Partial match on last name.
limitinteger- Maximum number of records to return, from 1 to 100. Follow Up Boss returns 10 when this is omitted.
namestring- Partial match on the relationship's full name.
offsetinteger- Number of records to skip before returning results, used for paging (e.g. 25 to get the second page of 25). Results are newest first by default.
person_idinteger- Return relationships for this person ID.
sortstring- Field to sort by: id, created, updated, name, firstName, lastName, personId. Prefix with a minus sign for descending order (e.g. -id).
followupboss_pipeline_getGet one deal pipeline in Follow Up Boss by ID.Read-onlyGet Pipeline
Get one deal pipeline in Follow Up Boss by ID. Returns the pipeline's name and its stages. Use it when you have the pipeline ID. Use followupboss_pipelines_list to see all pipelines.
Inputs
idintegerrequired- Numeric ID of the pipeline.
followupboss_pipelines_listList deal pipelines in Follow Up Boss, including each pipeline's stages.Read-onlyList Pipelines
List deal pipelines in Follow Up Boss, including each pipeline's stages. Returns pipelines with id, name and their deal stages (id and name). Use it to get a stage_id for followupboss_deal_create or a pipeline_id for followupboss_deals_list.
Inputs
limitinteger- Maximum number of records to return, from 1 to 100. Follow Up Boss returns 10 when this is omitted.
namestring- Return the pipeline with exactly this name.
offsetinteger- Number of records to skip before returning results, used for paging (e.g. 25 to get the second page of 25). Results are newest first by default.
followupboss_pond_getGet one pond in Follow Up Boss by ID.Read-onlyGet Pond
Get one pond in Follow Up Boss by ID. Returns the pond's name and members. Use it when you have the pond ID. Use followupboss_ponds_list to see all ponds.
Inputs
idintegerrequired- Numeric ID of the pond.
followupboss_ponds_listList ponds (shared pools of unassigned leads) in the Follow Up Boss account.Read-onlyList Ponds
List ponds (shared pools of unassigned leads) in the Follow Up Boss account. Returns ponds with id, name and member users. Use it to get an assigned_pond_id for people tools or the people_list filter.
Inputs
limitinteger- Maximum number of records to return, from 1 to 100. Follow Up Boss returns 10 when this is omitted.
offsetinteger- Number of records to skip before returning results, used for paging (e.g. 25 to get the second page of 25). Results are newest first by default.
followupboss_smart_list_getGet one smart list in Follow Up Boss by ID.Read-onlyGet Smart List
Get one smart list in Follow Up Boss by ID. Returns the smart list's name and filter settings. Use it to inspect a smart list. Use followupboss_people_list with smart_list_id to get its people.
Inputs
idintegerrequired- Numeric ID of the smart list.
followupboss_smart_lists_listList smart lists (saved people filters) in Follow Up Boss.Read-onlyList Smart Lists
List smart lists (saved people filters) in Follow Up Boss. Returns smart lists with id and name. Use it to find a smart list ID, then pass it as smart_list_id to followupboss_people_list to get the people in it.
Inputs
allboolean- Set to true to return all smart lists from both the classic and current interfaces.
fub2boolean- Set to true to return smart lists made in the current Follow Up Boss interface; by default only classic-interface lists are returned.
limitinteger- Maximum number of records to return, from 1 to 100. Follow Up Boss returns 10 when this is omitted.
offsetinteger- Number of records to skip before returning results, used for paging (e.g. 25 to get the second page of 25). Results are newest first by default.
followupboss_stage_getGet one people stage in Follow Up Boss by ID.Read-onlyGet Stage
Get one people stage in Follow Up Boss by ID. Returns the stage's name and order. Use it when you have the stage ID. Use followupboss_stages_list to see all stages.
Inputs
idintegerrequired- Numeric ID of the stage.
followupboss_stages_listList the people stages (Lead, Prospect, Active Client, Past Client, Trash and any custom stages) in the Follow Up Boss account.Read-onlyList Stages
List the people stages (Lead, Prospect, Active Client, Past Client, Trash and any custom stages) in the Follow Up Boss account. Returns stages with id, name and order. Use it to get valid stage names for followupboss_person_create, followupboss_person_update and the stage filter on followupboss_people_list. Deal stages come from followupboss_pipelines_list.
Inputs
limitinteger- Maximum number of records to return, from 1 to 100. Follow Up Boss returns 10 when this is omitted.
offsetinteger- Number of records to skip before returning results, used for paging (e.g. 25 to get the second page of 25). Results are newest first by default.
sortstring- Field to sort by: orderWeight, id, name. Prefix with a minus sign for descending order (e.g. -orderWeight). Defaults to orderWeight.
followupboss_task_getGet one task in Follow Up Boss by ID.Read-onlyGet Task
Get one task in Follow Up Boss by ID. Returns the task's name, type, due date and time, assignee, person and completion status. Use it when you have the task ID. Use followupboss_tasks_list to find tasks.
Inputs
idintegerrequired- Numeric ID of the task.
followupboss_tasks_listList tasks in Follow Up Boss, filtered by person, assignee, name, type, completion or due date.Read-onlyList Tasks
List tasks in Follow Up Boss, filtered by person, assignee, name, type, completion or due date. Returns a page of tasks with id, name, type, due date, assignee, person and completion status. Use it to see what is due or overdue. Use followupboss_task_get for one task by ID.
Inputs
assigned_tostring- Return tasks assigned to the user with this full name.
assigned_user_idinteger- Return tasks assigned to this user ID.
duestring- Due-date bucket: today, overdue or upcoming.one of
todayoverdueupcoming due_endstring- Return tasks due at or before this date and time (ISO 8601).
due_startstring- Return tasks due at or after this date and time (ISO 8601).
is_completedboolean- true returns completed tasks; false returns open tasks.
limitinteger- Maximum number of records to return, from 1 to 100. Follow Up Boss returns 10 when this is omitted.
namestring- Partial match on task name (e.g. world matches hello world).
offsetinteger- Number of records to skip before returning results, used for paging (e.g. 25 to get the second page of 25). Results are newest first by default.
person_idinteger- Return only tasks for this person ID.
typestring- Task type, or a comma-separated list: Follow Up, Call, Email, Text, Appointment, Showing, Closing, Open House, Thank You.
followupboss_team_getGet one team in Follow Up Boss by ID.Read-onlyGet Team
Get one team in Follow Up Boss by ID. Returns the team's name, leaders and members. Use it when you have the team ID. Use followupboss_teams_list to see all teams.
Inputs
idintegerrequired- Numeric ID of the team.
followupboss_team_inboxes_listList the shared team inboxes in the Follow Up Boss account.Read-onlyList Team Inboxes
List the shared team inboxes in the Follow Up Boss account. Returns team inboxes with id, name and members. Use it to see which shared inboxes exist and who can access them.
Inputs
This tool takes no inputs.
followupboss_teams_listList teams in the Follow Up Boss account.Read-onlyList Teams
List teams in the Follow Up Boss account. Returns teams with id, name and members. Use it to see team structure. Use followupboss_team_get for one team.
Inputs
limitinteger- Maximum number of records to return, from 1 to 100. Follow Up Boss returns 10 when this is omitted.
offsetinteger- Number of records to skip before returning results, used for paging (e.g. 25 to get the second page of 25). Results are newest first by default.
followupboss_text_message_getGet one text message in Follow Up Boss by ID.Read-onlyGet Text Message
Get one text message in Follow Up Boss by ID. Returns the message body, direction, phone numbers, person and timestamps. Use it when you have the message ID. Use followupboss_text_messages_list for a conversation.
Inputs
idintegerrequired- Numeric ID of the text message.
followupboss_text_messages_listList text messages in Follow Up Boss for a person or phone number.Read-onlyList Text Messages
List text messages in Follow Up Boss for a person or phone number. Returns text messages with body, direction, phone numbers, person and timestamps. Use it to read a conversation with a contact. Use followupboss_text_message_get for one message by ID. Provide person_id or a phone number.
Inputs
from_numberstring- Return text messages sent from this phone number.
limitinteger- Maximum number of records to return, from 1 to 100. Follow Up Boss returns 10 when this is omitted.
offsetinteger- Number of records to skip before returning results, used for paging (e.g. 25 to get the second page of 25). Results are newest first by default.
person_idinteger- Return text messages for this person ID.
to_numberstring- Return text messages sent to this phone number.
followupboss_text_template_getGet one text message template in Follow Up Boss by ID.Read-onlyGet Text Message Template
Get one text message template in Follow Up Boss by ID. Returns the template's name, message and sharing setting. Use it when you have the template ID. Use followupboss_text_templates_list to find templates.
Inputs
idintegerrequired- Numeric ID of the text message template.
followupboss_text_templates_listList text message templates in Follow Up Boss.Read-onlyList Text Message Templates
List text message templates in Follow Up Boss. Returns templates with id, name, message and sharing setting. Use it to find a template ID. Use followupboss_text_template_merge to fill it in for a person.
Inputs
limitinteger- Maximum number of records to return, from 1 to 100. Follow Up Boss returns 10 when this is omitted.
offsetinteger- Number of records to skip before returning results, used for paging (e.g. 25 to get the second page of 25). Results are newest first by default.
followupboss_timeframes_listList the buying/selling timeframes (for example 0-3 months) defined in the Follow Up Boss account.Read-onlyList Timeframes
List the buying/selling timeframes (for example 0-3 months) defined in the Follow Up Boss account. Returns timeframes with id and name. Use it to get a timeframe_id for followupboss_person_create or followupboss_person_update.
Inputs
This tool takes no inputs.
followupboss_unclaimed_people_listList unclaimed leads currently offered to the connected user (first-to-claim lead routing).Read-onlyList Unclaimed Leads
List unclaimed leads currently offered to the connected user (first-to-claim lead routing). Returns the unclaimed people available to claim. Use it to see leads waiting to be picked up. Use followupboss_person_claim to take one and followupboss_person_unclaimed_ignore to pass on it.
Inputs
limitinteger- Maximum number of records to return, from 1 to 100. Follow Up Boss returns 10 when this is omitted.
offsetinteger- Number of records to skip before returning results, used for paging (e.g. 25 to get the second page of 25). Results are newest first by default.
followupboss_user_getGet one Follow Up Boss user by ID.Read-onlyGet User
Get one Follow Up Boss user by ID. Returns the user's name, email, phone, role, status and team details. Use it when you have a user ID. Use followupboss_users_list to search users.
Inputs
idintegerrequired- Numeric ID of the user.
followupboss_users_listList users (agents, brokers, lenders and admins) in the Follow Up Boss account, optionally filtered by role, name or email.Read-onlyList Users
List users (agents, brokers, lenders and admins) in the Follow Up Boss account, optionally filtered by role, name or email. Returns users with id, name, email, role and status. Use it to find a user ID for assigning people, tasks or deals. Use followupboss_user_get for one user and followupboss_current_user_get for yourself.
Inputs
emailstring- Email address of the user.
fieldsstring- Comma-separated fields to return, or allFields for everything (calling details are only returned when named).
include_deletedboolean- Set to true to include deleted users.
limitinteger- Maximum number of records to return, from 1 to 100. Follow Up Boss returns 10 when this is omitted.
namestring- Exact full name of the user (no partial matching).
offsetinteger- Number of records to skip before returning results, used for paging (e.g. 25 to get the second page of 25). Results are newest first by default.
rolestring- Return users with this role, e.g. Broker, Agent or Lender.
sortstring- Field to sort by: id, name, created. Prefix with a minus sign for descending order (e.g. -id).
followupboss_action_plan_person_applyStart an action plan for a person in Follow Up Boss.WriteApply Action Plan to Person
Start an action plan for a person in Follow Up Boss. Returns the new action-plan assignment. Use it to enroll a contact in a follow-up sequence. Get the plan ID from followupboss_action_plans_list.
Inputs
action_plan_idintegerrequired- ID of the action plan to apply.
person_idintegerrequired- ID of the person to enroll.
followupboss_action_plan_person_updatePause or resume an action plan that is applied to a person in Follow Up Boss.WritePause or Resume Action Plan
Pause or resume an action plan that is applied to a person in Follow Up Boss. Returns the updated assignment. Use it to stop or restart a contact's sequence. Get the assignment ID from followupboss_action_plan_people_list.
- Idempotent
Inputs
idintegerrequired- ID of the action-plan assignment (from followupboss_action_plan_people_list), not the action plan itself.
statusstringrequired- Running to resume, Paused to pause.one of
RunningPaused
followupboss_appointment_createCreate an appointment in Follow Up Boss with a title, start and end time, and optional invitees, location, type and outcome.WriteCreate Appointment
Create an appointment in Follow Up Boss with a title, start and end time, and optional invitees, location, type and outcome. Returns the created appointment. Use it to book a showing or meeting. Use followupboss_task_create for a to-do without a calendar slot.
Inputs
endstringrequired- End date and time (ISO 8601, UTC or with a time zone offset).
startstringrequired- Start date and time (ISO 8601, UTC or with a time zone offset).
titlestringrequired- Title of the appointment.
all_dayboolean- Set to true for an all-day appointment.
created_by_idinteger- User ID to record as the creator. Only admins can set this; otherwise the current user is used.
descriptionstring- Description or agenda for the appointment.
inviteesarray- Users and people to invite. A user item has userId and name; a person item has personId, name and email. Example: [{"userId": 1, "name": "Tom Minch"}, {"personId": 123, "name": "John Q Customer", "email": "johnq@example.com"}]
locationstring- Location or address of the appointment.
outcome_idinteger- Appointment outcome ID. List outcomes with followupboss_appointment_outcomes_list.
send_invitationboolean- Set to true to email an invitation to the invitees (and an SMS reminder if appointment reminders are enabled).
type_idinteger- Appointment type ID. List types with followupboss_appointment_types_list.
followupboss_appointment_updateUpdate an appointment in Follow Up Boss, for example to reschedule it, change invitees or record an outcome.WriteUpdate Appointment
Update an appointment in Follow Up Boss, for example to reschedule it, change invitees or record an outcome. Returns the updated appointment. Use it to reschedule or close out an appointment. The vendor requires title, start and end on every update, so resend the current values for any you are not changing. Get the ID from followupboss_appointments_list.
- Idempotent
Inputs
endstringrequired- End date and time (ISO 8601, UTC or with a time zone offset).
idintegerrequired- Numeric ID of the appointment.
startstringrequired- Start date and time (ISO 8601, UTC or with a time zone offset).
titlestringrequired- Title of the appointment.
all_dayboolean- Set to true for an all-day appointment.
descriptionstring- Description or agenda for the appointment.
inviteesarray- Users and people to invite. A user item has userId and name; a person item has personId, name and email. Example: [{"userId": 1, "name": "Tom Minch"}, {"personId": 123, "name": "John Q Customer", "email": "johnq@example.com"}]
locationstring- Location or address of the appointment.
outcome_idinteger- Appointment outcome ID. List outcomes with followupboss_appointment_outcomes_list.
send_invitationboolean- Set to true to email an invitation to the invitees (and an SMS reminder if appointment reminders are enabled).
type_idinteger- Appointment type ID. List types with followupboss_appointment_types_list.
followupboss_automation_person_triggerManually run an automation for a person in Follow Up Boss.WriteTrigger Automation for Person
Manually run an automation for a person in Follow Up Boss. Returns the new automation-person pairing. Use it to start an automation that has a manual trigger. Find one with followupboss_automations_list (manual_only true).
Inputs
automation_idintegerrequired- ID of the automation to run.
person_idintegerrequired- ID of the person to run it for.
followupboss_automation_person_updatePause or resume an automation that is running for a person in Follow Up Boss.WritePause or Resume Automation Run
Pause or resume an automation that is running for a person in Follow Up Boss. Returns the updated pairing. Use it to stop or restart an automation for one contact. Get the pairing ID from followupboss_automation_people_list.
- Idempotent
Inputs
idintegerrequired- Numeric ID of the automation-person pairing.
statusstringrequired- Paused to pause, Running to resume.one of
RunningPaused
followupboss_call_createLog a phone call with a person in Follow Up Boss, with direction, outcome, duration and a note.WriteLog Call
Log a phone call with a person in Follow Up Boss, with direction, outcome, duration and a note. Returns the created call record. Use it to record a call made outside Follow Up Boss. Use followupboss_note_create for a general note.
Inputs
is_incomingbooleanrequired- true for an incoming call, false for an outgoing call.
person_idintegerrequired- ID of the person the call was with.
phonestringrequired- Phone number the call was made to or from.
durationinteger- Length of the call in seconds.
from_numberstring- Number the call was made from.
notestring- Call log note.
outcomestring- Result of the call.one of
InterestedNot InterestedLeft MessageNo AnswerBusyBad Number recording_urlstring- URL of the call recording.
to_numberstring- Number the call was made to.
user_idinteger- User who made or received the call. Only admins can set this; otherwise the current user is used.
followupboss_call_updateUpdate a logged call in Follow Up Boss, for example its note, outcome or duration; fields you leave out stay unchanged.WriteUpdate Call
Update a logged call in Follow Up Boss, for example its note, outcome or duration; fields you leave out stay unchanged. Returns the updated call record. Use it to correct a call log. Get the ID from followupboss_calls_list.
- Idempotent
Inputs
idintegerrequired- Numeric ID of the call.
durationinteger- Length of the call in seconds.
from_numberstring- Number the call was made from.
is_incomingboolean- true for an incoming call, false for an outgoing call.
notestring- Call log note.
outcomestring- Result of the call.one of
InterestedNot InterestedLeft MessageNo AnswerBusyBad Number person_idinteger- ID of the person the call was with.
phonestring- Phone number the call was made to or from.
recording_urlstring- URL of the call recording.
to_numberstring- Number the call was made to.
user_idinteger- User who made or received the call. Only admins can set this; otherwise the current user is used.
followupboss_deal_createCreate a deal in a Follow Up Boss pipeline stage, with people, agents, price, commission and transaction dates.WriteCreate Deal
Create a deal in a Follow Up Boss pipeline stage, with people, agents, price, commission and transaction dates. Returns the created deal. Use it to start tracking a transaction. Get a stage ID from followupboss_pipelines_list first.
Inputs
namestringrequired- Name of the deal.
stage_idintegerrequired- ID of the pipeline stage the deal is in. Get stage IDs from followupboss_pipelines_list (each pipeline lists its stages).
agent_commissioninteger- Agent's share of the commission.
commission_valueinteger- Total commission value for the deal.
descriptionstring- Description of the deal.
due_diligence_datestring- Due diligence date (YYYY-MM-DD).
earnest_money_due_datestring- Earnest money due date (YYYY-MM-DD).
final_walk_through_datestring- Final walk-through date (YYYY-MM-DD).
mutual_acceptance_datestring- Mutual acceptance date (YYYY-MM-DD).
order_weightinteger- Sort weight to force the deal's position within its stage.
people_idsarray- IDs of the people (clients) on the deal. Example: [1234, 1235]
possession_datestring- Possession date (YYYY-MM-DD).
priceinteger- Deal price in whole currency units.
projected_close_datestring- Projected close date (YYYY-MM-DD).
team_commissioninteger- Team's share of the commission.
user_idsarray- IDs of the users (agents) on the deal. Example: [12]
followupboss_deal_updateUpdate a deal in Follow Up Boss, for example to move it to another stage or change its price, people or dates; fields you leave out stay unchanged.WriteUpdate Deal
Update a deal in Follow Up Boss, for example to move it to another stage or change its price, people or dates; fields you leave out stay unchanged. Returns the updated deal. Use it to advance or edit a deal. Get the ID from followupboss_deals_list.
- Idempotent
Inputs
idintegerrequired- Numeric ID of the deal.
commission_valueinteger- Total commission value for the deal.
descriptionstring- Description of the deal.
due_diligence_datestring- Due diligence date (YYYY-MM-DD).
earnest_money_due_datestring- Earnest money due date (YYYY-MM-DD).
final_walk_through_datestring- Final walk-through date (YYYY-MM-DD).
mutual_acceptance_datestring- Mutual acceptance date (YYYY-MM-DD).
namestring- Name of the deal.
people_idsarray- IDs of the people (clients) on the deal. Example: [1234, 1235]
possession_datestring- Possession date (YYYY-MM-DD).
priceinteger- Deal price in whole currency units.
projected_close_datestring- Projected close date (YYYY-MM-DD).
stage_idinteger- ID of the pipeline stage the deal is in. Get stage IDs from followupboss_pipelines_list (each pipeline lists its stages).
user_idsarray- IDs of the users (agents) on the deal. Example: [12]
followupboss_email_template_createCreate an email template in Follow Up Boss.WriteCreate Email Template
Create an email template in Follow Up Boss. Returns the created template. Use it to save reusable email content. Merge fields like %contact_name% are filled in when the template is used.
Inputs
bodystringrequired- HTML body of the email.
namestringrequired- Name of the template.
subjectstringrequired- Email subject line.
is_sharedboolean- Set to true to share the template with other users in the account.
followupboss_email_template_mergeFill in an email template's merge fields for a person and a list of recipients in Follow Up Boss.WriteMerge Email Template
Fill in an email template's merge fields for a person and a list of recipients in Follow Up Boss. Returns the merged subject and body ready to send. Use it to prepare personalized email content. It does not send the email.
Inputs
template_idintegerrequired- ID of the email template.
merge_person_idinteger- Person whose details fill merge fields like %contact_name%.
recipientsobject- Recipients for the To: line, as an object with a to list of {name, email}. Example: {"to": [{"name": "Jane Doe", "email": "jane@example.com"}]}
followupboss_email_template_updateReplace an email template's name, subject and body in Follow Up Boss.WriteUpdate Email Template
Replace an email template's name, subject and body in Follow Up Boss. Returns the updated template. Use it to edit a template. All three fields are required, so resend current values for any you are not changing (read them with followupboss_email_template_get).
- Idempotent
Inputs
bodystringrequired- New HTML body.
idintegerrequired- Numeric ID of the email template.
namestringrequired- New name of the template.
subjectstringrequired- New subject line.
followupboss_event_createSend a new lead or a lead activity (inquiry, property view, registration, call and so on) into Follow Up Boss, the recommended way to add leads.WriteSend In Lead or Event
Send a new lead or a lead activity (inquiry, property view, registration, call and so on) into Follow Up Boss, the recommended way to add leads. Returns the event, with the person it was matched to or created for (people are de-duplicated by email and phone). A 204 means the lead was ignored by an account rule. Use it for inbound leads so lead routing, action plans and automations run. Use followupboss_person_create to add a contact by hand without lead-flow behavior.
Inputs
campaignobject- Marketing campaign attribution. source is required inside it; medium, term, content and campaign are optional. Example: {"source": "Google", "medium": "organic", "term": "austin homes"}
descriptionstring- Any extra information about the inquiry or activity.
messagestring- Message the lead wrote with the inquiry.
occurred_atstring- When the event happened (ISO 8601). Events more than a day old are treated as historical and do not trigger workflows.
page_durationinteger- For Viewed Page events: seconds the visitor spent on the page.
page_referrerstring- For Viewed Page events: the referring URL the visitor came from.
page_titlestring- For Viewed Page events: title of the page viewed.
page_urlstring- For Viewed Page events: URL of the page viewed.
personobject- The lead who triggered the event. Include identifying details so Follow Up Boss can match or create the person: firstName, lastName, emails and phones (lists of {value, type}), plus optional stage, source, tags, assignedUserId, price, addresses, id (to target a known person) and custom fields (keys starting with custom). Example: {"firstName": "Jane", "lastName": "Doe", "emails": [{"value": "jane@example.com"}], "phones": [{"value": "555-555-1234"}], "tags": ["Buyer"]}
propertyobject- The property the event is about: street, city, state, code (ZIP as a string), mlsNumber, price, forRent, url, type, and bedrooms, bathrooms, area (square feet) and lot (acres) as strings. Example: {"street": "100 Main St", "city": "Austin", "state": "TX", "code": "78701", "price": 450000, "mlsNumber": "1234567"}
property_searchobject- What the lead was searching for: type, neighborhood, city, state, code (ZIP or list of ZIPs), minPrice, maxPrice, minBedrooms, maxBedrooms, minBathrooms, maxBathrooms. Example: {"city": "Austin", "state": "TX", "minPrice": 300000, "maxPrice": 500000, "minBedrooms": 3}
sourcestring- Name of the lead source (the brand or website the lead came from), e.g. MyWebsite.com or Zillow.
systemstring- Name of the system that captured the lead, e.g. the website platform or CRM integration.
typestring- Kind of event. Use Registration for a new sign-up, an Inquiry type for questions, or Viewed/Saved Property, Visited Website, Incoming Call, Property Search and so on for activity on an existing lead.one of
RegistrationInquirySeller InquiryProperty InquiryGeneral InquiryViewed PropertySaved PropertyVisited WebsiteIncoming CallUnsubscribedProperty SearchSaved Property SearchVisited Open HouseViewed Page
followupboss_note_createAdd a note to a person's timeline in Follow Up Boss.WriteCreate Note
Add a note to a person's timeline in Follow Up Boss. Returns the created note with its id, subject, body and author. Use it to log context about a contact. Use followupboss_call_create to log a phone call instead.
Inputs
person_idintegerrequired- ID of the person the note is about.
bodystring- Content of the note. Plain text unless is_html is true.
is_htmlboolean- Set to true to render HTML tags in the body in the Follow Up Boss interface.
subjectstring- Title or subject of the note.
followupboss_note_updateEdit an existing note in Follow Up Boss; fields you leave out stay unchanged.WriteUpdate Note
Edit an existing note in Follow Up Boss; fields you leave out stay unchanged. Returns the updated note. Use it to correct or extend a note. Use followupboss_note_create to add a new one.
- Idempotent
Inputs
idintegerrequired- Numeric ID of the note.
bodystring- New content of the note.
is_htmlboolean- Set to true to render HTML tags in the body.
person_idinteger- ID of the person the note is linked to; set it to move the note to another person.
subjectstring- New title or subject of the note.
followupboss_person_claimClaim an unclaimed lead for the connected user in Follow Up Boss.WriteClaim Lead
Claim an unclaimed lead for the connected user in Follow Up Boss. Returns the claim result; a 409 means the lead was already claimed. Use it after followupboss_unclaimed_people_list to take a lead. Use followupboss_person_unclaimed_ignore to pass instead.
Inputs
person_idintegerrequired- ID of the unclaimed lead to claim.
followupboss_person_createManually add a person (contact) to Follow Up Boss with their name, stage, contact details, tags, assignment and custom fields.WriteCreate Person
Manually add a person (contact) to Follow Up Boss with their name, stage, contact details, tags, assignment and custom fields. Returns the created person record, or the existing match when deduplicate is true and one is found. Use it to add a contact by hand. Use followupboss_event_create to send in a new lead from a lead source, which also triggers lead-routing automations.
Inputs
addressesarray- Mailing or contact addresses for the person (not the address of a property they want to buy or sell). Each item can have a type (home, work, mailing, investment), street, city, state (2-letter code), code (ZIP, as a string) and country. Example: [{"type": "home", "street": "100 Main St", "city": "Austin", "state": "TX", "code": "78701"}]
assigned_lender_idinteger- ID of the lender (user with the Lender role) to assign to the person.
assigned_lender_namestring- Full name of the lender to assign, as an alternative to assigned_lender_id.
assigned_pond_idinteger- ID of the pond to put the person in. List ponds with followupboss_ponds_list.
assigned_tostring- Full name of the agent to assign the person to, as an alternative to assigned_user_id.
assigned_user_idinteger- ID of the agent (user) to assign the person to. Get user IDs from followupboss_users_list. Use this or assigned_to.
backgroundstring- Free-text background information about the person. Can span several lines.
collaboratorsarray- User IDs to add as collaborators on the person. Example: [12, 15]
contactedboolean- Whether the person has been contacted. Setting this to true pauses any running action plans for the person.
created_atstring- Creation time to record, for importing historical leads (ISO 8601, UTC).
custom_fieldsobject- Values for the account's custom fields, as an object whose keys are the custom field names (they always start with custom, e.g. customClosingDate). Find the names with followupboss_custom_fields_list. Set a key to null to clear that field. Example: {"customClosingDate": "2025-06-30"}
deduplicateboolean- Set to true to return an existing person with the same email or phone instead of creating a duplicate (the existing record is not changed). By default a new person is always created.
emailsarray- Email addresses for the person. Each item needs a value (the address) and usually a type such as work or home; the first item becomes the primary address. Example: [{"value": "jane@example.com", "type": "home"}]
first_namestring- First (given) name of the person.
last_namestring- Last (family) name of the person.
phonesarray- Phone numbers for the person. Each item needs a value and usually a type such as mobile, home, work or fax; the first item becomes the primary number. Example: [{"value": "555-555-1234", "type": "mobile"}]
priceinteger- Price of the property in the person's first inquiry, or their estimated buy/sell price, in whole currency units.
sourcestring- Lead source to record for the person, e.g. Zillow or Open House.
source_urlstring- Direct link to the person's record at the lead provider.
stagestring- Stage name such as Lead, Prospect, Active Client, Past Client or Trash. Stage names are account-specific; list them with followupboss_stages_list.
tagsarray- Tags to apply to the person. A Seller tag marks the lead as a seller; otherwise the lead is treated as a buyer. Example: ["Buyer", "Zillow"]
timeframe_idinteger- ID of the buying/selling timeframe for the person. List valid IDs with followupboss_timeframes_list.
followupboss_person_relationship_createAdd a related contact (spouse, partner, family member and so on) to a person in Follow Up Boss.WriteCreate Person Relationship
Add a related contact (spouse, partner, family member and so on) to a person in Follow Up Boss. Returns the created relationship. Use it to record a co-buyer or household member. Use followupboss_person_create for an independent contact.
Inputs
person_idintegerrequired- ID of the person the relationship belongs to.
addressesarray- Mailing or contact addresses for the related contact (not the address of a property they want to buy or sell). Each item can have a type (home, work, mailing, investment), street, city, state (2-letter code), code (ZIP, as a string) and country. Example: [{"type": "home", "street": "100 Main St", "city": "Austin", "state": "TX", "code": "78701"}]
emailsarray- Email addresses for the related contact. Each item needs a value (the address) and usually a type such as work or home; the first item becomes the primary address. Example: [{"value": "jane@example.com", "type": "home"}]
first_namestring- First name of the related contact.
last_namestring- Last name of the related contact.
phonesarray- Phone numbers for the related contact. Each item needs a value and usually a type such as mobile, home, work or fax; the first item becomes the primary number. Example: [{"value": "555-555-1234", "type": "mobile"}]
typestring- How they are related to the person, e.g. Spouse, Partner or Brother.
followupboss_person_relationship_updateUpdate a related contact's name, type or contact details in Follow Up Boss; fields you leave out stay unchanged.WriteUpdate Person Relationship
Update a related contact's name, type or contact details in Follow Up Boss; fields you leave out stay unchanged. Returns the updated relationship. Use it to correct a relationship. Get the ID from followupboss_person_relationships_list.
- Idempotent
Inputs
idintegerrequired- Numeric ID of the relationship.
addressesarray- Mailing or contact addresses for the related contact (not the address of a property they want to buy or sell). Each item can have a type (home, work, mailing, investment), street, city, state (2-letter code), code (ZIP, as a string) and country. Example: [{"type": "home", "street": "100 Main St", "city": "Austin", "state": "TX", "code": "78701"}]
emailsarray- Email addresses for the related contact. Each item needs a value (the address) and usually a type such as work or home; the first item becomes the primary address. Example: [{"value": "jane@example.com", "type": "home"}]
first_namestring- First name of the related contact.
last_namestring- Last name of the related contact.
phonesarray- Phone numbers for the related contact. Each item needs a value and usually a type such as mobile, home, work or fax; the first item becomes the primary number. Example: [{"value": "555-555-1234", "type": "mobile"}]
typestring- How they are related to the person, e.g. Spouse, Partner or Brother.
followupboss_person_unclaimed_ignoreIgnore (pass on) an unclaimed lead offered to the connected user in Follow Up Boss.WriteIgnore Unclaimed Lead
Ignore (pass on) an unclaimed lead offered to the connected user in Follow Up Boss. Returns no content on success. Use it to decline a lead from followupboss_unclaimed_people_list. Use followupboss_person_claim to take it instead.
Inputs
person_idintegerrequired- ID of the unclaimed lead to ignore.
followupboss_person_updateUpdate fields on an existing person in Follow Up Boss; fields you leave out stay unchanged.WriteUpdate Person
Update fields on an existing person in Follow Up Boss; fields you leave out stay unchanged. Returns the updated person record. Use it to change a contact's stage, assignment, contact details, tags or custom fields. Note that emails, phones and tags replace the existing lists unless merge_tags is set for tags. Get the ID from followupboss_people_list.
- Idempotent
Inputs
idintegerrequired- Numeric ID of the person.
addressesarray- Mailing or contact addresses for the person (not the address of a property they want to buy or sell). Each item can have a type (home, work, mailing, investment), street, city, state (2-letter code), code (ZIP, as a string) and country. Example: [{"type": "home", "street": "100 Main St", "city": "Austin", "state": "TX", "code": "78701"}]
assigned_lender_idinteger- ID of the lender (user with the Lender role) to assign to the person.
assigned_lender_namestring- Full name of the lender to assign, as an alternative to assigned_lender_id.
assigned_pond_idinteger- ID of the pond to put the person in. List ponds with followupboss_ponds_list.
assigned_tostring- Full name of the agent to assign the person to, as an alternative to assigned_user_id.
assigned_user_idinteger- ID of the agent (user) to assign the person to. Get user IDs from followupboss_users_list. Use this or assigned_to.
backgroundstring- Free-text background information about the person. Can span several lines.
contactedboolean- Whether the person has been contacted. Setting this to true pauses any running action plans for the person.
custom_fieldsobject- Values for the account's custom fields, as an object whose keys are the custom field names (they always start with custom, e.g. customClosingDate). Find the names with followupboss_custom_fields_list. Set a key to null to clear that field. Example: {"customClosingDate": "2025-06-30"}
emailsarray- Email addresses for the person. Each item needs a value (the address) and usually a type such as work or home; the first item becomes the primary address. Sending this replaces the existing list, so include every address you want to keep. Example: [{"value": "jane@example.com", "type": "home"}]
first_namestring- First (given) name of the person.
last_namestring- Last (family) name of the person.
merge_tagsboolean- Set to true to add the tags you send to the person's existing tags instead of replacing them.
phonesarray- Phone numbers for the person. Each item needs a value and usually a type such as mobile, home, work or fax; the first item becomes the primary number. Sending this replaces all existing numbers (including ones linked to relationships), so include every number you want to keep. Example: [{"value": "555-555-1234", "type": "mobile"}]
priceinteger- Price of the property in the person's first inquiry, or their estimated buy/sell price, in whole currency units.
stagestring- Stage name such as Lead, Prospect, Active Client, Past Client or Trash. Stage names are account-specific; list them with followupboss_stages_list.
tagsarray- Tags to apply to the person. By default this replaces all existing tags; set merge_tags to true to add to them instead. Example: ["Buyer", "Zillow"]
timeframe_idinteger- ID of the buying/selling timeframe for the person. List valid IDs with followupboss_timeframes_list.
followupboss_task_createCreate a task for a person in Follow Up Boss, assigned to an agent, with an optional type, due date and reminder.WriteCreate Task
Create a task for a person in Follow Up Boss, assigned to an agent, with an optional type, due date and reminder. Returns the created task. Use it to schedule follow-up work. Use followupboss_appointment_create for a calendar appointment instead. Provide assigned_user_id or assigned_to.
Inputs
person_idintegerrequired- ID of the person the task is about.
assigned_tostring- Full name of the agent to assign the task to. Required if assigned_user_id is empty.
assigned_user_idinteger- ID of the user to assign the task to. Required if assigned_to is empty.
due_datestring- Due date in YYYY-MM-DD format, for tasks without a time.
due_date_timestring- Due date and time, with an optional time zone offset (ISO 8601). Needed for reminders.
is_completedboolean- Set to true to create the task already completed.
namestring- Name of the task.
remind_seconds_beforeinteger- Send an email and desktop reminder this many seconds before the due time. Only works when due_date_time is set.
typestring- Task type.one of
Follow UpCallTextEmailAppointmentShowingClosingOpen HouseThank You
followupboss_task_updateUpdate a task in Follow Up Boss, for example to mark it complete, rename it, change its type or reassign it; fields you leave out stay unchanged.WriteUpdate Task
Update a task in Follow Up Boss, for example to mark it complete, rename it, change its type or reassign it; fields you leave out stay unchanged. Returns the updated task. Use it to complete or reassign a task. Get the ID from followupboss_tasks_list.
- Idempotent
Inputs
idintegerrequired- Numeric ID of the task.
assigned_tostring- Full name of the agent to reassign the task to.
assigned_user_idinteger- ID of the user to reassign the task to.
is_completedboolean- Set to true to mark the task complete, or false to reopen it.
namestring- New name of the task.
person_idinteger- ID of the person the task should be linked to.
typestring- New task type.one of
Follow UpCallTextEmailAppointmentShowingClosingOpen HouseThank You
followupboss_text_template_createCreate a text message template in Follow Up Boss.WriteCreate Text Message Template
Create a text message template in Follow Up Boss. Returns the created template. Use it to save reusable text content. Merge fields like %contact_name% are filled in when the template is used.
Inputs
messagestringrequired- Body of the text message.
namestringrequired- Name of the template.
is_sharedboolean- Set to true to share the template with other users in the account.
followupboss_text_template_mergeFill in a text message template's merge fields for a person and a list of recipients in Follow Up Boss.WriteMerge Text Message Template
Fill in a text message template's merge fields for a person and a list of recipients in Follow Up Boss. Returns the merged message text. Use it to prepare a personalized text. It does not send the message.
Inputs
template_idintegerrequired- ID of the text message template.
person_idinteger- Person whose details fill merge fields like %contact_name%.
recipientsobject- Recipients, as an object with a to list of {name, phone}. Example: {"to": [{"name": "Jane Doe", "phone": "555-555-1234"}]}
followupboss_text_template_updateReplace a text message template's name and message in Follow Up Boss.WriteUpdate Text Message Template
Replace a text message template's name and message in Follow Up Boss. Returns the updated template. Use it to edit a template. name and message are both required, so resend the current value for whichever you are not changing.
- Idempotent
Inputs
idintegerrequired- Numeric ID of the text message template.
messagestringrequired- New body of the text message.
namestringrequired- New name of the template.
is_sharedboolean- Set to true to share the template with other users.
No tools match.
