Skip to main content
Follow Up Boss logo
  • Category: crm
  • Auth: API_KEY, OAUTH2
  • Composio-managed OAuth available? No
  • Tools: 112
  • Triggers: 0
  • Slug: FOLLOW_UP_BOSS
  • Version: 20261101_00

Tools

Slug: FOLLOW_UP_BOSS_CREATE_ACTION_PLANS_PEOPLETool to apply an Action Plan to a person in Follow Up Boss. Use when you need to assign or apply a specific action plan workflow to a contact.

Input Parameters

integer
required
The ID of the person to whom you would like to apply the action plan.
integer
required
The ID of the action plan to apply

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FOLLOW_UP_BOSS_CREATE_APPOINTMENTTool to create a new appointment in Follow Up Boss. Use when you need to schedule meetings, property showings, or events. Requires title, start time, and end time. Optionally send invitation emails to invitees.

Input Parameters

string
required
The ending date and time of the appointment in ISO 8601 format (UTC). Also supports time zone suffix (e.g., ‘2026-02-15T11:00:00Z’ or ‘2026-02-15T11:00:00-08:00’).
string
required
The beginning date and time of the appointment in ISO 8601 format (UTC). Also supports time zone suffix (e.g., ‘2026-02-15T10:00:00Z’ or ‘2026-02-15T10:00:00-08:00’).
string
required
Title of the appointment.
boolean
Sets whether the appointment is an all day event or not. Defaults to false.
integer
The Follow Up Boss appointment type identifier.
array
Array of users and/or people to invite to the appointment. Each invitee can have userId (for team members) or personId (for contacts/leads), along with optional name and email.
string
The location or address of the appointment.
integer
The Follow Up Boss appointment outcome identifier.
integer
The ID of the user that created the appointment. Note: This can only be set by admins, otherwise the currently logged in user’s ID is used.
string
Description of the appointment or event.
boolean
Send an invitation email to invitees. If the ‘appointment reminders’ feature is enabled, an SMS reminder will also be sent. Defaults to false.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FOLLOW_UP_BOSS_CREATE_APPOINTMENT_OUTCOMETool to create an appointment outcome in Follow Up Boss. Use when you need to add a new outcome type for appointment tracking.

Input Parameters

string
required
Name of the appointment outcome.
integer
Set this value to enforce a specific sort order. Higher values appear later in the list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FOLLOW_UP_BOSS_CREATE_APPOINTMENT_TYPESTool to create a new appointment type in Follow Up Boss. Use when you need to define a new category for appointments that can be scheduled in the system.

Input Parameters

string
required
The name of the appointment type.
integer
Set this value to enforce a specific sort order. Higher values appear later in the list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FOLLOW_UP_BOSS_CREATE_CALLTool to add a call record to Follow Up Boss. Use when you need to log a phone call interaction with a person.

Input Parameters

string
The log message entered for this call.
string
required
The phone number this call was made to or from.
integer
The ID of the user that made or received a call. This can only be set by administrators; otherwise the currently logged in user’s ID is used.
string ("Interested" | "Not Interested" | "Left Message" | "No Answer" | "Busy" | "Bad Number")
Possible outcomes for a call.
integer
Length of the call in seconds.
integer
required
The ID of a person associated with this call.
string
The phone number this call was made to.
string
The phone number this call was made from.
boolean
required
Sets this as an incoming or outgoing call.
string
The URL for the call recording.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FOLLOW_UP_BOSS_CREATE_CUSTOM_FIELDTool to create a custom field in Follow Up Boss. Use when you need to add a new custom data field to person records, such as tracking anniversaries, customer types, or any other custom information.

Input Parameters

string ("text" | "date" | "number" | "dropdown")
required
The type of custom field to create. Choose ‘text’ for free-form text input, ‘date’ for date values, ‘number’ for numeric values, or ‘dropdown’ for a list of predefined choices.
string
required
The user-friendly name of the custom field (e.g., “Anniversary”, “Customer Type”). This is the label that will be displayed in the UI.
array
Array of options for a custom field of type ‘dropdown’. Required when type is ‘dropdown’, ignored for other types. Each string represents one selectable option.
boolean
When viewing a person, hide this field if it has no value. Defaults to false. Useful for keeping profiles clean by only showing fields with data.
boolean
Whether a date field occurs every year (e.g., birthdays, anniversaries). Only applicable for ‘date’ type custom fields. Defaults to false.
integer
A weighted integer used for custom sorting of fields. Higher values appear later in the list. Defaults to 0.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FOLLOW_UP_BOSS_CREATE_DEAL_CUSTOM_FIELDTool to create a custom field for deals in Follow Up Boss. Use when you need to add custom metadata fields to track deal-specific information like stages, priorities, or custom dates.

Input Parameters

string ("text" | "date" | "number" | "dropdown")
required
The type of deal custom field to create.
string
required
The user-friendly name of the custom field (e.g., ‘Anniversary’, ‘Deal Stage’).
array
Array of options for a deal custom field of type ‘dropdown’. Required when type is ‘dropdown’, ignored otherwise.
boolean
Determines whether the deal custom field is read-only. Defaults to false.
boolean
Sets whether to hide this field if it is empty. Defaults to false.
boolean
Whether a date field occurs every year (e.g. birthdays, anniversaries). Only applicable when type is ‘date’. Defaults to false.
integer
A weighted integer for custom sorting of fields. Higher weights appear later. Defaults to 0.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FOLLOW_UP_BOSS_CREATE_DEALSTool to create a new deal in Follow Up Boss. Use when you need to add a deal to track sales opportunities in your pipeline. Requires deal name and stage ID.

Input Parameters

string
required
Name of the deal. This is a required field that identifies the deal.
integer
The price associated with this deal in cents or as an integer value.
integer
required
The stage ID that this deal should be assigned to. This is a required field. Use the appropriate stage ID from your Follow Up Boss pipeline configuration.
array
A list of user IDs that should be part of this deal.
array
A list of person IDs that should be part of this deal.
string
Description of the deal. Provides additional context or notes about the deal.
integer
Set this value to enforce a specific sort order for the deal.
string
Possession Date for this deal in date format (YYYY-MM-DD).
integer
Commission split for the team split, typically as a percentage.
integer
Commission split for the agent split, typically as a percentage.
integer
Commission value to assign to this deal.
string
Due Diligence Date for this deal in date format (YYYY-MM-DD).
string
Projected close date of this deal in date format (YYYY-MM-DD). This is the expected date when the deal will be closed.
string
Earnest Money Due Date for this deal in date format (YYYY-MM-DD).
string
Final Walk Through Date for this deal in date format (YYYY-MM-DD).
string
Mutual Acceptance Date for this deal in date format (YYYY-MM-DD).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FOLLOW_UP_BOSS_CREATE_EM_CAMPAIGNTool to create an email marketing campaign in Follow Up Boss. Use when you need to create a new email campaign with HTML content.

Input Parameters

string
required
Name of the email campaign or template.
string
required
Name of the email marketing system where this campaign originated from.
string
required
Email subject line.
string
required
Email body in HTML format. Must be valid HTML.
string
required
Internal ID of the new campaign or email in the origin system. Must be unique.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FOLLOW_UP_BOSS_CREATE_EM_EVENTSSend email marketing events to Follow Up Boss to track deliveries, opens, clicks, bounces, and unsubscribes. A success response may not confirm that individual events were accepted.

Input Parameters

array
required
Array of email marketing event objects. Can send up to 1000 events per request.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FOLLOW_UP_BOSS_CREATE_EVENTSTool to send in a lead or an event related to a lead in Follow Up Boss. Use when you need to track lead activities, inquiries, property views, or any other event type supported by the system.

Input Parameters

string ("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" | "Viewed Page")
Event types supported by Follow Up Boss.
object
Information about the lead who triggered this event.
string
The name of the lead source
string
The name of the system used in providing leads
string
A message from the user about this inquiry
string
This field is to be used with the ‘Viewed Page’ event type and indicates the url of the page viewed
object
Marketing campaign information.
object
Information about the property this event is related to.
string
This field is to be used with the ‘Viewed Page’ event type and indicates the title of the page viewed
string
The date this event occurred (format: YYYY-MM-DD). Events older than 1 day are considered historical and won’t trigger workflows
string
Any additional information about this inquiry
integer
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
string
This field is to be used with the ‘Viewed Page’ event type and indicates the referrer url where the visitor came from (Note: If pageReferrer is sent in, pageUrl should be set as well)
Information about what the person was searching for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FOLLOW_UP_BOSS_CREATE_GROUPSTool to create a new Follow Up Boss group with specified members and distribution settings. Use when you need to organize team members into groups for lead distribution.

Input Parameters

string
required
The name of the group.
string ("Agent" | "Lender")
Type of group defining which user roles can be members.
array
required
An array of user IDs that will be members of this group.
integer
Number of seconds to allow someone to claim a lead in a first-to-claim group before reassigning. The default is 30 minutes (1800 seconds) with a minimum of 1 minute (60) and maximum of 30 minutes (1800).
string ("first-to-claim" | "round-robin")
Distribution model for group lead assignment.
integer
The ID of the pond to assign unclaimed first-to-claim leads to after the claim window expires.
integer
The ID of the user to assign unclaimed first-to-claim leads to after the claim window expires.
integer
The ID of the group to assign unclaimed first-to-claim leads to after the claim window expires.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FOLLOW_UP_BOSS_CREATE_NOTECreate a note attached to one Follow Up Boss person and return the created record.

Input Parameters

string
Optional note content.
boolean
Whether Follow Up Boss should render HTML tags in the body.
string
Optional note title or subject.
integer
required
ID of the person to attach the note to.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FOLLOW_UP_BOSS_CREATE_PEOPLE_RELATIONSHIPCreate a relationship attached to one Follow Up Boss person and return the created relationship.

Input Parameters

string
Relationship type, such as Spouse, Brother, or Partner.
array
Email addresses for the related person.
array
Phone numbers for the related person.
string
Related person’s last name.
integer
required
ID of the person this relationship belongs to.
array
Contact addresses for the related person.
string
Related person’s first name.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FOLLOW_UP_BOSS_CREATE_PERSONManually create a CRM person without running lead-ingestion automations. Use Create Events instead to ingest a lead and trigger deduplication, assignment, notifications, and action plans.

Input Parameters

array
Tags to apply to the person.
integer
The first inquiry property price or estimated buy or sell price.
string
The person’s stage, such as Lead or Trash.
array
Email addresses to associate with the person.
array
Phone numbers to associate with the person.
string
The person’s lead source; this can only be set during creation.
string
The person’s last name.
array
Contact addresses for the person, not properties they may buy or sell.
boolean
Whether the person has been contacted.
string
Historical creation date for the person in YYYY-MM-DD format.
string
The person’s first name.
string
A direct link to the person at the lead provider; this can only be set during creation.
string
The full name of the agent assigned to the person.
string
Background information about the person; may be multiline.
boolean
Return an existing email or phone match without changing it instead of creating a duplicate.
integer
The ID of the timeframe assigned to the person.
object
Custom person fields keyed by their custom-prefixed API names, such as customClosingDate.
array
User IDs to set as collaborators on the person.
integer
The ID of the pond assigned to the person.
integer
The ID of the agent assigned to the person.
integer
The ID of the lender assigned to the person.
string
The full name of the lender assigned to the person.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FOLLOW_UP_BOSS_CREATE_PIPELINESTool to create a new pipeline in Follow Up Boss. Use when you need to set up a new pipeline for tracking deals with customizable stages. Only the owner has access to create and modify pipelines.

Input Parameters

string
required
The name of the pipeline.
array
An array of stage objects that should be associated with the pipeline. Each stage must have a name and closedStage indicator.
string
Description of the pipeline.
integer
Set this value to enforce a specific sort order. The system will recalculate orderWeight values after creation to maintain 1000-unit gaps between pipelines.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FOLLOW_UP_BOSS_CREATE_PONDSTool to create a new pond in Follow Up Boss. Use when you need to organize leads into a specific group with a lead agent and member users.

Input Parameters

string
required
The name of the pond you want to create
integer
required
The Pond Lead Agent user ID
array
required
IDs of all users to add as members of the pond

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FOLLOW_UP_BOSS_CREATE_REACTIONSTool to add a reaction (emoji) to a Note, Call, or ThreadedReply. Use when you need to add an emoji reaction to existing content.

Input Parameters

string
required
The single-character emoji reaction (e.g., 👍, ❤️, 😀).
integer
required
The ID of the item that is being reacted to.
string ("Note" | "Call" | "ThreadedReply")
required
The type of entity that is being reacted to.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FOLLOW_UP_BOSS_CREATE_STAGETool to create a new stage in Follow Up Boss. Use when you need to add a new pipeline stage for organizing contacts.

Input Parameters

string
required
Name of the stage.
integer
Set this value to enforce a specific sort order. Higher values appear later in the list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FOLLOW_UP_BOSS_CREATE_TASKCreate a Follow Up Boss task for a person and assign it by user ID or full name.

Input Parameters

string
Task name.
string ("Follow Up" | "Call" | "Text" | "Email" | "Appointment" | "Showing" | "Closing" | "Open House" | "Thank You")
Task type: Follow Up, Call, Text, Email, Appointment, Showing, Closing, Open House, or Thank You.
string
Due date in YYYY-MM-DD format.
integer
required
ID of the person related to the task.
string
Full name of the assigned agent; required when assignedUserId is omitted.
string
Due timestamp including a timezone suffix.
boolean
Whether the task starts completed.
integer
Assigned user ID; required when assignedTo is omitted.
integer
Reminder lead time in seconds; requires dueDateTime.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FOLLOW_UP_BOSS_CREATE_TEAMSTool to create a new team in Follow Up Boss. Use when you need to organize users into teams with optional team leaders.

Input Parameters

string
required
The name of the team.
array
required
An array of user IDs that will be members of this team. At least one user ID is required.
array
The complete list of team leaders. Optional. If not provided, the team will have no leaders.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FOLLOW_UP_BOSS_CREATE_TEMPLATETool to create a new email template in Follow Up Boss. Use when you need to create a reusable email template with a name, subject, and HTML body.

Input Parameters

string
required
The HTML body of the email template.
string
required
The name of the new email template.
string
required
The email subject used when this email template is selected.
boolean
Indicates whether this email template should be shared with other users in the same Follow Up Boss account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FOLLOW_UP_BOSS_CREATE_TEXT_MESSAGE_TEMPLATETool to create a text message template in Follow Up Boss. Use when you need to create a reusable SMS template that can include dynamic variables like contact names and greetings.

Input Parameters

string
required
The name of your text message template.
string
required
The body of your text message template. Can include variables like %greeting_time%, %contact_first_name%.
boolean
Set to true if this template should be shared with other users in the same Follow Up Boss account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FOLLOW_UP_BOSS_DELETE_APPOINTMENTTool to delete an appointment by ID. Use when you need to remove an existing appointment from Follow Up Boss.

Input Parameters

integer
required
The id of appointment to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FOLLOW_UP_BOSS_DELETE_APPOINTMENT_OUTCOMESTool to delete an appointment outcome by ID. Use when you need to remove an appointment outcome and reassign existing appointments to a different outcome.

Input Parameters

integer
required
ID of the appointment outcome to delete.
integer
required
The outcome ID to reassign existing appointments. When deleting an appointment outcome, any appointments with the deleted outcome will be reassigned to this outcome ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FOLLOW_UP_BOSS_DELETE_APPOINTMENT_TYPETool to delete an appointment type by its ID. Use when you need to remove an appointment type and reassign existing appointments to another type.

Input Parameters

integer
required
The id of the appointment type to delete.
integer
required
The typeId to reassign existing appointments to before deleting this appointment type.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FOLLOW_UP_BOSS_DELETE_CUSTOM_FIELDTool to delete a custom field by its ID. Use when you need to remove a custom field from Follow Up Boss. Restricted to account owners only.

Input Parameters

string
required
The ID of the custom field to delete. Must be a valid custom field ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FOLLOW_UP_BOSS_DELETE_DEALTool to delete a deal by its ID. Use when you need to permanently remove a deal from Follow Up Boss.

Input Parameters

integer
required
The id of the deal to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FOLLOW_UP_BOSS_DELETE_DEAL_CUSTOM_FIELDTool to delete a deal custom field by ID. Use when you need to permanently remove a custom field configuration from deals. Only the account owner can delete deal custom fields.

Input Parameters

integer
required
The id of the deal custom field to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FOLLOW_UP_BOSS_DELETE_GROUPSDelete a Follow Up Boss group by ID. The returned success flag may not confirm deletion if the API returns an error response.

Input Parameters

integer
required
The ID of the group to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FOLLOW_UP_BOSS_DELETE_PEOPLE_RELATIONSHIPTool to delete a people relationship by ID in Follow Up Boss. Use when you need to remove a relationship between contacts.

Input Parameters

integer
required
The relationship ID to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FOLLOW_UP_BOSS_DELETE_PIPELINETool to delete a pipeline by its ID from Follow Up Boss. Use when you need to permanently remove a pipeline from the system. The deletion is irreversible and will remove the pipeline and all associated data.

Input Parameters

integer
required
The id of the pipeline to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FOLLOW_UP_BOSS_DELETE_PONDTool to delete a pond by its ID. Use when removing a pond and reassigning its contacts to another agent.

Input Parameters

integer
required
The pond id to delete.
integer
required
Select which agent should receive any contacts currently in this pond after it is deleted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FOLLOW_UP_BOSS_DELETE_STAGETool to delete a Follow Up Boss stage by ID. Use when you need to remove a stage and reassign action plans to another stage.

Input Parameters

integer
required
The id of the stage to delete.
integer
required
The stage id to assign to action plans referencing the deleted stage.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FOLLOW_UP_BOSS_DELETE_TASKPermanently delete one Follow Up Boss task by numeric ID. This action cannot be undone.

Input Parameters

integer
required
The numeric ID of the task to delete permanently.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FOLLOW_UP_BOSS_DELETE_TEAMSTool to delete a team by its ID. Use when you need to remove a team from Follow Up Boss. Optionally merge team members to another team before deletion.

Input Parameters

string
required
The team id to delete.
integer
If you wish to merge two teams, use this parameter to indicate that all members of the current team should be made a member of the target team before this team is deleted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FOLLOW_UP_BOSS_DELETE_TEXT_MESSAGE_TEMPLATETool to delete a text message template by ID. Use when you need to remove a text message template. Note: If the template is in use by an Action Plan, you will get a 403 Forbidden response. Use GET /textMessageTemplates/:id to check which Action Plans are using it before deletion.

Input Parameters

integer
required
The ID of the text message template to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FOLLOW_UP_BOSS_GET_APPOINTMENTTool to retrieve an appointment by its ID. Use when you need to fetch details of a specific appointment.

Input Parameters

integer
required
The id of the appointment to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FOLLOW_UP_BOSS_GET_APPOINTMENT_OUTCOMETool to retrieve an appointment outcome by ID. Use when you need to fetch details about a specific appointment outcome from Follow Up Boss.

Input Parameters

integer
required
The id of the appointment outcome.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FOLLOW_UP_BOSS_GET_APPOINTMENT_TYPESTool to retrieve an appointment type by ID. Use when you need to fetch details about a specific appointment type from Follow Up Boss.

Input Parameters

integer
required
The id of the appointment type.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FOLLOW_UP_BOSS_GET_CALLTool to retrieve a call by its ID from Follow Up Boss. Use when you need to fetch details about a specific call record.

Input Parameters

integer
required
The ID of the call to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FOLLOW_UP_BOSS_GET_DEALRetrieve a deal by ID from Follow Up Boss. The returned deal details include only the custom fields explicitly represented in the response model.

Input Parameters

integer
required
The id of the deal to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FOLLOW_UP_BOSS_GET_DEAL_CUSTOM_FIELDTool to retrieve a deal custom field by its ID from Follow Up Boss. Use when you need to fetch details about a specific deal custom field configuration.

Input Parameters

integer
required
The id of a deals custom field.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FOLLOW_UP_BOSS_GET_EVENTTool to retrieve a single event by its ID from Follow Up Boss. Use when you need to fetch details about a specific event record.

Input Parameters

integer
required
The id of the event.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FOLLOW_UP_BOSS_GET_GROUPSTool to retrieve a group by its ID from Follow Up Boss. Use when you need to fetch details about a specific group.

Input Parameters

integer
required
The id of the group.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FOLLOW_UP_BOSS_GET_IDENTITYTool to retrieve identity and authentication information from Follow Up Boss. Use when you need to verify the authenticated user’s account and user details.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FOLLOW_UP_BOSS_GET_METool to retrieve information about the currently authenticated user. Use when you need to fetch details about the authenticated user’s account, settings, or permissions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FOLLOW_UP_BOSS_GET_PEOPLE_RELATIONSHIPTool to retrieve a people relationship by its ID from Follow Up Boss. Use when you need to fetch details about a specific relationship between contacts.

Input Parameters

integer
required
The ID of a given relationship.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FOLLOW_UP_BOSS_GET_PERSONRetrieve one Follow Up Boss person by numeric ID.

Input Parameters

integer
required
The numeric ID of the person to retrieve.
string
Comma-separated response fields, ‘allCustom’, or ‘allFields’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FOLLOW_UP_BOSS_GET_PIPELINESTool to retrieve a pipeline by its ID from Follow Up Boss. Use when you need to fetch details about a specific pipeline.

Input Parameters

integer
required
The id of the pipeline.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FOLLOW_UP_BOSS_GET_PONDSTool to retrieve a pond by its ID from Follow Up Boss. Use when you need to fetch details about a specific pond group.

Input Parameters

integer
required
The pond id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FOLLOW_UP_BOSS_GET_SMART_LISTTool to retrieve a Smart List by its ID from Follow Up Boss. Use when you need to fetch details about a specific Smart List.

Input Parameters

integer
required
The ID of the Smart List to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FOLLOW_UP_BOSS_GET_STAGETool to retrieve a stage by its ID from Follow Up Boss. Use when you need to fetch details about a specific stage.

Input Parameters

integer
required
The id of the stage to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FOLLOW_UP_BOSS_GET_TASKRetrieve one Follow Up Boss task by numeric ID.

Input Parameters

integer
required
The numeric ID of the task to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FOLLOW_UP_BOSS_GET_TEAMSTool to retrieve a team by its ID from Follow Up Boss. Use when you need to fetch details about a specific team.

Input Parameters

integer
required
The team id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FOLLOW_UP_BOSS_GET_TEMPLATETool to retrieve an email template by its ID from Follow Up Boss. Use when you need to fetch details about a specific template, optionally with merge fields populated for a person.

Input Parameters

integer
required
The ID of the template to retrieve.
integer
When specified, the returned template will have its merge fields filled out with the specified person record and the current user record.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FOLLOW_UP_BOSS_GET_TEXT_MESSAGETool to retrieve a text message by its ID from Follow Up Boss. Use when you need to fetch details about a specific text message record.

Input Parameters

integer
required
The id of the text message record.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FOLLOW_UP_BOSS_GET_TEXT_MESSAGE_TEMPLATERetrieve a Follow Up Boss text message template by ID, including its content and usage statistics when returned. Associated action plan entries are returned without their details.

Input Parameters

integer
required
The ID of the template.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FOLLOW_UP_BOSS_GET_USERTool to retrieve a user by its ID from Follow Up Boss. Use when you need to fetch details about a specific user.

Input Parameters

integer
required
The ID of a user.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FOLLOW_UP_BOSS_LIST_ACTION_PLANSTool to get a list of Action Plans from Follow Up Boss. Use when you need to retrieve available action plans with optional filtering by status, names, or IDs, and support for pagination and sorting.

Input Parameters

string
Search for Action Plans by id. Provide a comma-separated list of action plan IDs (e.g., ‘287564,67484,8436437’).
string
Sort Action Plans by a given field (e.g., ‘id’ or ‘name’). Prefix the field name with a minus (-) to sort in descending order (e.g., ‘-id’).
integer
Number of results to return. Max 100.
array
Search for Action Plans by name. Provide a list of action plan names to filter by. The API will return action plans matching any of the provided names.
integer
Specifies the number of rows to skip before starting to return results.
string
Search for Action Plans with one of the following statuses: ‘Active’, ‘Deleted’, or ‘Active,Deleted’ (if you want both).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FOLLOW_UP_BOSS_LIST_ACTION_PLANS_PEOPLETool to list Action Plans applied to a particular person or list people on a particular Action Plan. Use when you need to retrieve action plan assignments, optionally filtered by person or action plan.

Input Parameters

integer
Number of results to return. Max 100.
integer
Specifies the number of rows to skip before starting to return results.
integer
List Action Plans applied to a specified person.
integer
List People on the specified Action Plan.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FOLLOW_UP_BOSS_LIST_APPOINTMENT_OUTCOMESTool to list all appointment outcomes from Follow Up Boss. Use when you need to retrieve a list of appointment outcomes with optional sorting and pagination.

Input Parameters

string
The sort order can be one of the following: id, name, orderWeight. Prefix the string with a minus (-) to sort in descending order (e.g., -orderWeight).
integer
Number of results to return. Max 100.
integer
Specifies the number of rows to skip before starting to return results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FOLLOW_UP_BOSS_LIST_APPOINTMENTSTool to search for appointments in Follow Up Boss. Use when you need to retrieve a list of appointments, optionally filtered by person, user, or date range. Supports pagination for large result sets.

Input Parameters

string
Date and time representing the end of a date/time range for which to search (must be combined with the start argument). Use ISO 8601 format.
integer
Number of results to return. Maximum 100.
string
Date and time representing the start of a date/time range for which to search (must be combined with the end argument). Use ISO 8601 format.
integer
Specifies the number of rows to skip before starting to return results.
integer
Find all appointments related to a user by id.
integer
Find all appointments related to a person. Note: This can be a single person ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FOLLOW_UP_BOSS_LIST_APPOINTMENT_TYPESTool to list all appointment types from Follow Up Boss. Use when you need to retrieve a list of available appointment types with optional sorting and pagination.

Input Parameters

string
The sort order can be one of the following: id, name, orderWeight. Prefix the string with a minus (-) to sort in descending order (e.g., -orderWeight).
integer
Number of results to return. Max 100.
integer
Specifies the number of rows to skip before starting to return results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FOLLOW_UP_BOSS_LIST_CALLSTool to search for calls in Follow Up Boss. Use when you need to retrieve a list of calls with optional filtering by person ID or phone numbers.

Input Parameters

integer
Number of results to return. Max 100.
string
Filter calls based on the phone number of a specific person or lead. This will find calls regardless of whether they were incoming or outgoing.
integer
Specifies the number of rows to skip before starting to return results.
integer
Filter calls by a person ID.
string
Filter calls based on the number that the call was to.
string
Filter calls based on the number that the call was from.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FOLLOW_UP_BOSS_LIST_CUSTOM_FIELDSTool to list all custom fields in Follow Up Boss. Use when you need to retrieve custom field definitions, optionally filtered by label or sorted by specific fields.

Input Parameters

string ("id" | "-id" | "name" | "-name" | "orderWeight" | "-orderWeight")
Sort field options for custom fields.
string
Find custom field by label.
integer
Number of results to return. Max 100.
integer
Specifies the number of rows to skip, before starting to return results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FOLLOW_UP_BOSS_LIST_DEAL_CUSTOM_FIELDSList deal custom field definitions in Follow Up Boss, optionally filtered by label or sorted by specific fields. Results are paginated.

Input Parameters

string ("id" | "-id" | "name" | "-name" | "orderWeight" | "-orderWeight")
Sort field options for deal custom fields.
string
Find custom field by label.
integer
Number of results to return. Max 100.
integer
Specifies the number of rows to skip, before starting to return results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FOLLOW_UP_BOSS_LIST_DEALSTool to search for and list deals from Follow Up Boss. Use when you need to retrieve multiple deals with optional filters by pipeline, user, person, or status.

Input Parameters

string
Field to sort by (e.g., ‘id’, ‘created’).
integer
Number of results to return. Max 100.
integer
Specifies the number of rows to skip before starting to return results.
string ("Active" | "Archived" | "Deleted")
Status values for filtering deals.
integer
Return a list of deals for a specific user. Filter by user ID.
integer
Return a list of deals for a specific person. Filter by person ID.
integer
Return deals for a specific pipeline only. Filter by pipeline ID.
integer
Set to 1 to include deals with a status of Deleted in the results. Set to 0 or omit to exclude deleted deals.
integer
Set to 1 to include deals with a status of Archived in the results. Set to 0 or omit to exclude archived deals.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FOLLOW_UP_BOSS_LIST_EM_CAMPAIGNSList email marketing campaigns from Follow Up Boss, optionally filtering by origin or origin ID. Results are paginated.

Input Parameters

string
Field to sort by (e.g., ‘id’, ‘created’).
integer
Number of results to return. Max 100.
integer
Specifies the number of rows to skip before starting to return results.
string
Search for campaigns from a specific origin (e.g., ‘Mailchimp’, ‘Campaign Monitor’). If not specified, returns campaigns from all origins.
string
Search for campaigns with a specific ID from the originating system. Use this to find campaigns by their external system identifier.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FOLLOW_UP_BOSS_LIST_EM_EVENTSRetrieve paginated email marketing events from Follow Up Boss, including deliveries, opens, clicks, bounces, unsubscribes, and spam reports. Filter by event type, person, or an updated-after timestamp.

Input Parameters

string ("delivered" | "open" | "click" | "bounced" | "soft-bounce" | "hard-bounce" | "unsubscribe" | "spamreport" | "dropped")
Possible types of email marketing events.
integer
Number of results to return. Maximum 100.
integer
Specifies the number of rows to skip before starting to return results.
integer
Find email marketing events by person ID.
string
Find email marketing events that have been created or updated after the specified time. Use ISO 8601 format.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FOLLOW_UP_BOSS_LIST_EVENTSTool to search for and list events from Follow Up Boss. Use when you need to retrieve events with optional filtering by person, event type, property association, or property address, with pagination support.

Input Parameters

string
To get the next page of results, set this to the value returned in _metadata.next, or use the URL from _metadata.nextLink directly.
string
Comma separated list of one or more of the following: ‘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’.
integer
Number of results to return. Max 100.
integer
Specifies the number of rows to skip, before starting to return results. (For more efficient paging, please use the ‘next’ parameter instead.)
integer
Find all events related to a person.
boolean
Filters based on whether a property is associated with an event or not.
string
Searches property addresses for a given value, including partial matches.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FOLLOW_UP_BOSS_LIST_GROUPSTool to list all groups from Follow Up Boss. Use when you need to retrieve a list of groups, optionally filtered by type (Agent/Lender) or sorted by id/name.

Input Parameters

string ("id" | "-id" | "name" | "-name")
Sort field options for groups.
string ("Agent" | "Lender")
Type of group.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FOLLOW_UP_BOSS_LIST_GROUPS_ROUND_ROBINTool to list groups with round-robin data from Follow Up Boss. Use when you need to retrieve groups configured for round-robin distribution.

Input Parameters

string ("id" | "name" | "-id" | "-name")
Enum for sort field values.
string ("Agent" | "Lender")
Enum for group type values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FOLLOW_UP_BOSS_LIST_INBOX_APPSTool to list all inbox app installations from Follow Up Boss. Use when you need to retrieve a list of installed inbox apps with optional pagination.

Input Parameters

integer
Number of results to return. Max 100.
integer
Specifies the number of rows to skip before starting to return results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FOLLOW_UP_BOSS_LIST_NOTESList Follow Up Boss notes using person, time-window, and sort filters.

Input Parameters

string
Cursor returned in _metadata.next for the next page.
string
Response field to sort by; prefix with - for descending order.
integer
Number of notes to return per page, from 1 to 100.
integer
Number of rows to skip; next is preferred for deep paging.
integer
Person ID whose notes should be returned.
string
ISO-8601 lower bound for the note creation time.
string
ISO-8601 lower bound for the note update time.
string
ISO-8601 upper bound for the note creation time.
string
ISO-8601 upper bound for the note update time.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FOLLOW_UP_BOSS_LIST_PEOPLESearch and list Follow Up Boss people using contact and CRM filters.

Input Parameters

string
One person ID or a comma-separated list of person IDs.
string
Cursor returned in _metadata.next for the next page.
string
Response field to sort by; prefix with - for descending order.
string
Comma-separated tags; matches people with any listed tag.
string
Email address to match.
integer
Number of people to return per page, from 1 to 100.
string
Stage name to match.
string
Comma-separated response fields, allCustom, or allFields.
integer
Number of rows to skip; next is preferred for deep paging.
boolean
Whether matched people have been contacted.
string
ISO-8601 lower creation-time bound.
boolean
Whether to include people in Trash.
string
ISO-8601 upper creation-time bound.
integer
Assigned pond ID to match.
integer
Assigned user ID to match.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FOLLOW_UP_BOSS_LIST_PEOPLE_RELATIONSHIPSList a page of Follow Up Boss people relationships, optionally filtered by person ID, name, or first/last name and sorted. The response may include pagination metadata.

Input Parameters

string
Searches for person with a name like what is given. (e.g., If you search for drew, it might return a contact like Andrew.)
string
The sort order. Can be one of the following: id, created, updated, name, firstName, lastName, personId. Prefix the string with a minus (-) to sort in descending order (e.g., -created).
string
Searches for person with a last name like what is given. (e.g., If you search for drew, it might return a contact like Andrew.)
integer
Filter relationships by a person ID.
string
Searches for person with a first name like what is given. (e.g., If you search for drew, it might return a contact like Andrew.)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FOLLOW_UP_BOSS_LIST_PIPELINESTool to search for pipelines in Follow Up Boss. Use when you need to retrieve a list of pipelines, optionally filtering by exact name match.

Input Parameters

string
The pipeline name to lookup. (Must be an exact match.)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FOLLOW_UP_BOSS_LIST_PONDSTool to list all ponds from Follow Up Boss. Use when you need to retrieve a list of pond groups with pagination support.

Input Parameters

integer
Number of results to return. Max 100.
integer
Specifies the number of rows to skip before starting to return results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FOLLOW_UP_BOSS_LIST_SMART_LISTSTool to list Smart Lists from Follow Up Boss. Use when you need to retrieve a list of Smart Lists with support for pagination and filtering by FUB version.

Input Parameters

boolean
Use this parameter to show all smart lists, whether from FUB Classic or FUB.
boolean
By default this endpoint only returns Smart Lists created in the classic version of our UI. To return Smart Lists created in our current version, use this parameter.
integer
Number of results to return. Max 100.
integer
Specifies the number of rows to skip before starting to return results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FOLLOW_UP_BOSS_LIST_STAGESTool to retrieve a list of stages from Follow Up Boss. Use when you need to fetch all stages with optional pagination and sorting.

Input Parameters

string ("orderWeight" | "id" | "name")
Sort options for listing stages.
integer
Number of results to return. Max 100.
integer
Specifies the number of rows to skip before starting to return results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FOLLOW_UP_BOSS_LIST_TASKSList Follow Up Boss tasks using assignee, due-date, and task filters.

Input Parameters

string ("today" | "overdue" | "upcoming")
Due-date range to match: today, overdue, or upcoming.
string
Text to match within the task name.
string
Cursor returned in _metadata.next for the next page.
string
Response field to sort by; prefix with - for descending order.
string
Task type or comma-separated types: Follow Up, Call, Email, Text, Appointment, Showing, Closing, Open House, or Thank You.
integer
Number of tasks to return per page, from 1 to 100.
string
ISO-8601 upper bound for the task due time.
integer
Number of rows to skip; next is preferred for deep paging.
string
ISO-8601 lower bound for the task due time.
integer
Person ID whose related tasks should be returned.
string
Full name of the user assigned to the task.
boolean
Whether to return completed or incomplete tasks.
integer
User ID assigned to the task.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FOLLOW_UP_BOSS_LIST_TEAM_INBOXESTool to list all shared team inboxes from Follow Up Boss. Use when you need to retrieve available team inboxes with their names, IDs, and users who have access.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FOLLOW_UP_BOSS_LIST_TEAMSTool to get a list of teams from Follow Up Boss. Use when you need to retrieve all teams with pagination support. Note: Not all plans have access to the teams feature. If you do not have access, this endpoint will return a 200 OK response with an empty teams list.

Input Parameters

integer
Number of results to return. Max 100.
integer
Specifies the number of rows to skip before starting to return results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FOLLOW_UP_BOSS_LIST_TEMPLATESTool to list all email templates from Follow Up Boss. Use when you need to retrieve multiple email templates with pagination support.

Input Parameters

integer
Number of results to return. Max 100.
integer
Specifies the number of rows to skip before starting to return results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FOLLOW_UP_BOSS_LIST_TEXT_MESSAGESTool to list text messages for a person or phone number from Follow Up Boss. Use when you need to retrieve text messages with filtering options. Note: At least one filter parameter must be provided when calling this action.

Input Parameters

string
Filter by specific text message ID(s).
string
Filter by phone number.
integer
Filter text messages for a specific person id only. Note: At least one filter parameter must be provided.
integer
Filter by thread ID.
string
Filter text messages sent to a specific recipient’s phone number.
string
Filter text messages sent from a specific sender’s phone number.
integer
Filter by group text ID.
string
Filter by participants.
integer
Filter by shared inbox ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FOLLOW_UP_BOSS_LIST_TEXT_MESSAGE_TEMPLATESTool to list all text message templates from Follow Up Boss. Use when you need to retrieve multiple text message templates with pagination support.

Input Parameters

integer
Number of results to return. Max 100.
integer
Specifies the number of rows to skip before starting to return results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FOLLOW_UP_BOSS_LIST_TIMEFRAMESTool to get a list of timeframes from Follow Up Boss. Use when you need to retrieve available timeframes.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FOLLOW_UP_BOSS_LIST_USERSTool to search for and list users from Follow Up Boss. Use when you need to retrieve multiple users with optional filters by role, name, email, or other criteria.

Input Parameters

string
Find a user by their full name. Exact matches only, no partial matching available.
string
Find users by a specific role (e.g., ‘Broker’, ‘Agent’, ‘Lender’).
string
Field to sort by. Currently only ‘id’, ‘name’ and ‘created’ are available.
string
Find a user by their email address.
integer
Number of results to return. Max 100.
string
Comma separated list of fields (e.g., id,name,calling) to return or use ‘allFields’ to return all fields (except for calling information, unless included like allFields,calling). When using the fields parameter to filter the response, the id field will be included (even when not specified explicitly).
integer
Specifies the number of rows to skip before starting to return results.
boolean
Setting this to true will include users that have been deleted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FOLLOW_UP_BOSS_LIST_WEBHOOKSTool to retrieve a list of webhooks from Follow Up Boss. Use when you need to view registered webhooks with optional filtering by event type or status.

Input Parameters

string ("id" | "created" | "updated" | "status" | "event")
Sort order options for webhooks.
string
Search for webhooks by event (e.g., ‘peopleCreated’ or ‘peopleUpdated’).
integer
Number of results to return. Max 100.
integer
Specifies the number of rows to skip before starting to return results.
string ("Active" | "Disabled")
Status values for filtering webhooks.
string
The name of the registered system.
string
The key of the registered system.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FOLLOW_UP_BOSS_MERGE_TEMPLATETool to merge an email template with person data using Follow Up Boss API. Use when you need to generate personalized email content by replacing merge fields like %contact_name% with actual person data.

Input Parameters

object
Model for recipients object containing To/CC/BCC/From fields.
integer
required
The ID of the email template to merge.
integer
Person ID to use for merge fields like %contact_name%. If not provided, the first recipient matching a person will be used.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FOLLOW_UP_BOSS_MERGE_TEXT_MESSAGE_TEMPLATETool to merge a text message template with person data. Use when you need to generate personalized text messages by merging a template with contact information. The template supports merge fields like %contact_name% and %contact_rels_first_name% which are replaced with actual recipient data.

Input Parameters

integer
Person ID to use for merge fields like %contact_name%. If not provided, the first recipient will be used
object
Container for message recipients
integer
required
The ID of the text message template to merge

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FOLLOW_UP_BOSS_UPDATE_ACTION_PLANS_PEOPLETool to update the status of an Action Plan to Person relationship in Follow Up Boss. Use when you need to pause or resume an action plan applied to a contact.

Input Parameters

integer
required
The ID of the Action Plan People object to update.
string ("Running" | "Paused")
required
The desired state of the applied action plan. Either ‘Running’ or ‘Paused’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FOLLOW_UP_BOSS_UPDATE_APPOINTMENTTool to update an existing appointment in Follow Up Boss. Use when you need to modify appointment details like title, time, location, or invitees. Requires appointment ID, title, start time, and end time. Optionally send invitation emails to invitees.

Input Parameters

integer
required
The id of the appointment to update.
string
required
The ending date and time of the appointment in ISO 8601 format (UTC). Also supports time zone suffix (e.g., ‘2026-02-15T11:00:00Z’ or ‘2026-02-15T11:00:00-08:00’).
string
required
The beginning date and time of the appointment in ISO 8601 format (UTC). Also supports time zone suffix (e.g., ‘2026-02-15T10:00:00Z’ or ‘2026-02-15T10:00:00-08:00’).
string
required
Title of the appointment.
boolean
Sets whether the appointment is an all day event or not.
integer
The Follow Up Boss appointment type identifier.
array
Array of users and/or people to invite to the appointment. Each invitee can have userId (for team members) or personId (for contacts/leads), along with optional name and email.
string
The location or address of the appointment.
integer
The Follow Up Boss appointment outcome identifier.
string
Description of the appointment or event.
boolean
Send an invitation email to invitees. If the ‘appointment reminders’ feature is enabled, an SMS reminder will also be sent. Defaults to false.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FOLLOW_UP_BOSS_UPDATE_APPOINTMENT_OUTCOMESTool to update an existing appointment outcome in Follow Up Boss. Use when you need to modify the name or sort order of an appointment outcome.

Input Parameters

integer
required
The id of the appointment outcome to update.
string
The name of the appointment outcome.
integer
Set this value to enforce a specific sort order. Higher values appear later in the list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FOLLOW_UP_BOSS_UPDATE_APPOINTMENT_TYPESTool to update an existing appointment type in Follow Up Boss. Use when you need to modify the name or sort order of an appointment type.

Input Parameters

integer
required
The id of the appointment type to update.
string
The name of the appointment type.
integer
Set this value to enforce a specific sort order. Higher values appear later in the list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FOLLOW_UP_BOSS_UPDATE_CALLSTool to update an existing call record in Follow Up Boss. Use when you need to modify call details such as notes, duration, outcome, or other call attributes. Only calls created by the account/system making the API request can be updated.

Input Parameters

integer
required
The ID of the call to update.
string
The log message entered for this call.
string
The phone number this call was made to or from.
integer
The ID of the user that made or received a call. This can only be set by administrators; otherwise the currently logged in user’s ID is used.
string ("Interested" | "Not Interested" | "Left Message" | "No Answer" | "Busy" | "Bad Number")
Possible outcomes for a call.
integer
Length of the call in seconds.
integer
The ID of a person associated with this call.
string
The phone number this call was made to.
string
The phone number this call was made from.
boolean
Sets this as an incoming or outgoing call.
string
The URL for the call recording.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FOLLOW_UP_BOSS_UPDATE_CUSTOM_FIELDSTool to update an existing custom field in Follow Up Boss by its ID. Use when you need to modify the label, choices, ordering, or display settings of a custom field.

Input Parameters

integer
required
The ID of the custom field to update. Must be a valid custom field ID.
string
The user-friendly name of the custom field (e.g., “Anniversary”, “Customer Type”). This is the label that will be displayed in the UI.
array
Array of options related to a custom field of type ‘dropdown’. Each string represents one selectable option. Only applicable for dropdown type fields.
boolean
When viewing a person, hide this field if it has no value. Defaults to false. Useful for keeping profiles clean by only showing fields with data.
boolean
Sets whether a date field occurs every year (e.g., birthdays, anniversaries, etc.). Only applicable for ‘date’ type custom fields. Defaults to false.
integer
A weighted integer for the field to assign values for custom sorting. Higher values appear later in the list. Defaults to 0.
array
An optional mapping that points previous dropdown choices (keys) to their new positions (values). This is used to track when options get moved or renamed. If items are missing from the keys, they will be removed. If the mapping is not supplied, this endpoint will try to determine if items have been moved or renamed on its own.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FOLLOW_UP_BOSS_UPDATE_DEAL_CUSTOM_FIELDSTool to update an existing deal custom field in Follow Up Boss. Use when you need to modify custom field properties like label, type, display settings, or dropdown choices.

Input Parameters

integer
required
The id of the deals custom field to update.
string ("text" | "date" | "number" | "dropdown")
required
The type of deal custom field.
string
required
The user-friendly name of the custom field (e.g., ‘Anniversary’, ‘Deal Stage’).
array
Array of options related to a deals custom field of type ‘dropdown’. Required when type is ‘dropdown’, ignored otherwise.
boolean
Determines whether the deal custom field is read-only. Defaults to false.
boolean
Sets whether to hide this field if it is empty. Defaults to false.
boolean
Whether a date field occurs every year (e.g. birthdays, anniversaries). Only applicable when type is ‘date’. Defaults to false.
integer
A weighted integer for custom sorting of fields. Higher weights appear later. Defaults to 0.
array
An optional mapping that points previous dropdown choices (keys) to their new positions (values). This is used to track when options get moved or renamed. If items are missing from the keys, they will be removed. If the mapping is not supplied, then this endpoint will try to determine if items have been moved or renamed on its own.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FOLLOW_UP_BOSS_UPDATE_DEALSTool to update an existing deal in Follow Up Boss. Use when you need to modify deal details such as name, price, description, stage, or associated people and users.

Input Parameters

integer
required
The id of the deal to update. This is a required field.
string
Name of the deal.
integer
The price associated with this deal.
integer
The stage that this deal should be assigned to.
array
A list of user ids that should be part of this deal.
array
A list of person ids that should be part of this deal.
string
Description of the deal.
string
Possession Date for this deal in date format (YYYY-MM-DD).
integer
Commission value for a team split.
integer
Commission value for an agent split.
integer
Commission value to assign to this deal.
string
Due Diligence Date for this deal in date format (YYYY-MM-DD).
string
Projected close date of this deal in date format (YYYY-MM-DD).
string
Earnest Money Due Date for this deal in date format (YYYY-MM-DD).
string
Final Walk Through Date for this deal in date format (YYYY-MM-DD).
string
Mutual Acceptance Date for this deal in date format (YYYY-MM-DD).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FOLLOW_UP_BOSS_UPDATE_EM_CAMPAIGNSTool to update an existing email marketing campaign in Follow Up Boss. Use when you need to modify campaign name, subject line, or HTML body content.

Input Parameters

integer
required
Follow Up Boss ID of the email campaign to update.
string
Name of the email campaign or template.
string
Email subject line.
string
Email body in HTML format.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FOLLOW_UP_BOSS_UPDATE_GROUPSUpdate an existing Follow Up Boss group’s name, membership, and optional distribution settings. The group name and member user IDs are required on every update.

Input Parameters

integer
required
The id of the group to update.
string
required
The name of the group.
string ("Agent" | "Lender")
Type of group defining which user roles can be members.
array
required
An array of user IDs that will be members of this group.
integer
Number of seconds to allow someone to claim a lead in a first-to-claim group before reassigning. The default is 30 minutes (1800 seconds) with a minimum of 1 minute (60) and maximum of 30 minutes (1800).
string ("first-to-claim" | "round-robin")
Distribution model for group lead assignment.
integer
The ID of the pond to assign unclaimed first-to-claim leads to after the claim window expires.
integer
The ID of the user to assign unclaimed first-to-claim leads to after the claim window expires.
integer
The ID of the group to assign unclaimed first-to-claim leads to after the claim window expires.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FOLLOW_UP_BOSS_UPDATE_NOTEUpdate a Follow Up Boss note and return the complete updated record. Provide at least one of personId, subject, body, or isHtml.

Input Parameters

integer
required
Numeric ID of the note to update.
string
New note content.
boolean
Whether Follow Up Boss should render HTML tags in the body.
string
New note title or subject.
integer
New ID of the person associated with the note.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FOLLOW_UP_BOSS_UPDATE_PEOPLE_RELATIONSHIPSTool to update details of a specific people relationship in Follow Up Boss. Use when you need to modify relationship information such as name, type, contact details (emails, phones), or addresses.

Input Parameters

integer
required
The ID of a given relationship.
string
The type of relationship (e.g., Spouse, Brother, Partner, etc.).
array
A list of email addresses associated with the relationship. Specify type and value, isPrimary is not expected. The first email in the list will be the primary email address for the relationship.
array
A list of phone numbers associated with the relationship. Specify type and value, isPrimary is not expected. The first phone in the list will be the primary phone number for the relationship.
string
The last/family name of the relationship.
array
A list of addresses associated with the relationship. 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.
string
The first/given name of the relationship.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FOLLOW_UP_BOSS_UPDATE_PERSONUpdate a person’s first name, contacted state, tags, complete email or phone lists, or custom fields. Tags replace unless merged, null custom values delete them, and marking contacted pauses action plans.

Input Parameters

integer
required
The ID of the person to update.
array
The complete replacement tag list unless mergeTags is true.
array
The complete email list. Supplying it overwrites existing emails.
array
The complete phone list. Supplying it overwrites existing phones.
boolean
The contacted state. Setting this to true pauses action plans.
string
The person’s new first name.
boolean
Merge supplied tags instead of replacing existing tag membership.
object
Custom person fields keyed by their custom-prefixed API names. A null value deletes the stored value.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FOLLOW_UP_BOSS_UPDATE_PIPELINESTool to update an existing pipeline in Follow Up Boss. Use when you need to modify pipeline properties such as name, description, order, or stages. Only the owner has access to create and modify pipelines.

Input Parameters

integer
required
The id of the pipeline to update.
string
The name of the pipeline.
array
An array of stage objects that should be associated with the pipeline. Each stage must have a name and closedStage indicator.
string
Description of the pipeline.
integer
Set this value to enforce a specific sort order. The system will recalculate orderWeight values after update to maintain 1000-unit gaps between pipelines.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FOLLOW_UP_BOSS_UPDATE_PONDSTool to update an existing pond in Follow Up Boss. Use when you need to change the name, lead agent, or member list of a pond.

Input Parameters

integer
required
The pond id.
string
Set this value to change the name of the Pond
integer
Set this value to change the Pond Lead Agent
array
Set this value to add or remove members from the pond

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FOLLOW_UP_BOSS_UPDATE_STAGESTool to update an existing stage in Follow Up Boss. Use when you need to modify stage properties like name or sort order.

Input Parameters

integer
required
The id of the stage to update.
string
Name of the stage.
integer
Helps to set a specific sort order. Higher values appear later in the list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FOLLOW_UP_BOSS_UPDATE_TASKUpdate assignment, person, name, type, or completion state on one Follow Up Boss task.

Input Parameters

integer
required
The numeric ID of the task to update.
string
The new task name.
string ("Follow Up" | "Call" | "Email" | "Appointment" | "Showing" | "Closing" | "Open House" | "Thank You")
The new task type: Follow Up, Call, Email, Appointment, Showing, Closing, Open House, or Thank You.
integer
The new ID of the person related to the task.
string
The new full name of the agent assigned to the task.
boolean
Whether the task is completed.
integer
The new user ID assigned to the task.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FOLLOW_UP_BOSS_UPDATE_TEAMSTool to update an existing team in Follow Up Boss. Use when you need to modify team name, leaders, or members.

Input Parameters

integer
required
The team id to update.
string
The team name.
array
The complete list of members of this team. If provided, this replaces all existing members.
array
The complete list of team leaders. If provided, this replaces all existing leaders.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FOLLOW_UP_BOSS_UPDATE_TEMPLATESUpdate an existing Follow Up Boss email template by ID. The name, subject, and body must all be supplied.

Input Parameters

string
required
The ID of the email template to update.
string
required
The new body for the email template. May include merge fields like {{firstName}} or %contact_first_name%.
string
required
The new name for the email template.
string
required
The new subject for the email template.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FOLLOW_UP_BOSS_UPDATE_TEXT_MESSAGE_TEMPLATEUpdate an existing Follow Up Boss text message template by ID. The name and message are required; sharing settings can also be supplied.

Input Parameters

string
required
The ID of the text message template to update.
string
required
The name of your text message template.
string
required
The body of your text message template. Can include variables like %greeting_time%, %contact_first_name%, %agent_first_name%, %company_name%.
boolean
Set to true if this template should be shared with other users in the same Follow Up Boss account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not