Follow Up Boss

follow_up_boss

Follow Up Boss is the leading CRM for high-growth real estate businesses. Get all your leads in one place & take control of your follow up so you can work smarter.

CRM Web del proveedor

Acciones

Triggers

Autenticación

—

OAuth gestionado

Información técnica: el detalle de parámetros, schemas y triggers de esta página está pensado para equipos de integración. Si solo necesitas saber si tu herramienta favorita está disponible, basta con ver la lista de acciones.

Acciones disponibles (99)

Cada acción es una operación que el agente puede ejecutar contra este conector. Haz clic en una acción para ver sus parámetros.

Apply Action Plan to PersonFOLLOW_UP_BOSS_CREATE_ACTION_PLANS_PEOPLEAcción

Tool 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.

Parámetros de entrada

personIdintegerObligatorio
The ID of the person to whom you would like to apply the action plan.
actionPlanIdintegerObligatorio
The ID of the action plan to apply

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create AppointmentFOLLOW_UP_BOSS_CREATE_APPOINTMENTAcción

Tool 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.

Parámetros de entrada

endstringObligatorio
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').
startstringObligatorio
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').
titlestringObligatorio
Title of the appointment.
allDayboolean
Sets whether the appointment is an all day event or not. Defaults to false.
typeIdinteger
The Follow Up Boss appointment type identifier.
inviteesobject[]
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.
locationstring
The location or address of the appointment.
outcomeIdinteger
The Follow Up Boss appointment outcome identifier.
createdByIdinteger
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.
descriptionstring
Description of the appointment or event.
sendInvitationboolean
Send an invitation email to invitees. If the 'appointment reminders' feature is enabled, an SMS reminder will also be sent. Defaults to false.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create appointment outcomeFOLLOW_UP_BOSS_CREATE_APPOINTMENT_OUTCOMEAcción

Tool to create an appointment outcome in Follow Up Boss. Use when you need to add a new outcome type for appointment tracking.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create Appointment TypeFOLLOW_UP_BOSS_CREATE_APPOINTMENT_TYPESAcción

Tool 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.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create CallFOLLOW_UP_BOSS_CREATE_CALLAcción

Tool to add a call record to Follow Up Boss. Use when you need to log a phone call interaction with a person.

Parámetros de entrada

notestring
The log message entered for this call.
phonestringObligatorio
The phone number this call was made to or from.
userIdinteger
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.
outcomestringenum
Possible outcomes for a call.
InterestedNot InterestedLeft MessageNo AnswerBusyBad Number
durationinteger
Length of the call in seconds.
personIdintegerObligatorio
The ID of a person associated with this call.
toNumberstring
The phone number this call was made to.
fromNumberstring
The phone number this call was made from.
isIncomingbooleanObligatorio
Sets this as an incoming or outgoing call.
recordingUrlstring
The URL for the call recording.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create Custom FieldFOLLOW_UP_BOSS_CREATE_CUSTOM_FIELDAcción

Tool 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.

Parámetros de entrada

typestringObligatorioenum
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.
textdatenumberdropdown
labelstringObligatorio
The user-friendly name of the custom field (e.g., "Anniversary", "Customer Type"). This is the label that will be displayed in the UI.
choicesstring[]
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.
hideIfEmptyboolean
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.
isRecurringboolean
Whether a date field occurs every year (e.g., birthdays, anniversaries). Only applicable for 'date' type custom fields. Defaults to false.
orderWeightinteger
A weighted integer used for custom sorting of fields. Higher values appear later in the list. Defaults to 0.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create Deal Custom FieldFOLLOW_UP_BOSS_CREATE_DEAL_CUSTOM_FIELDAcción

Tool 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.

Parámetros de entrada

typestringObligatorioenum
The type of deal custom field to create.
textdatenumberdropdown
labelstringObligatorio
The user-friendly name of the custom field (e.g., 'Anniversary', 'Deal Stage').
choicesstring[]
Array of options for a deal custom field of type 'dropdown'. Required when type is 'dropdown', ignored otherwise.
readOnlyboolean
Determines whether the deal custom field is read-only. Defaults to false.
hideIfEmptyboolean
Sets whether to hide this field if it is empty. Defaults to false.
isRecurringboolean
Whether a date field occurs every year (e.g. birthdays, anniversaries). Only applicable when type is 'date'. Defaults to false.
orderWeightinteger
A weighted integer for custom sorting of fields. Higher weights appear later. Defaults to 0.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create DealFOLLOW_UP_BOSS_CREATE_DEALSAcción

Tool 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.

Parámetros de entrada

namestringObligatorio
Name of the deal. This is a required field that identifies the deal.
priceinteger
The price associated with this deal in cents or as an integer value.
stageIdintegerObligatorio
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.
userIdsinteger[]
A list of user IDs that should be part of this deal.
peopleIdsinteger[]
A list of person IDs that should be part of this deal.
descriptionstring
Description of the deal. Provides additional context or notes about the deal.
orderWeightinteger
Set this value to enforce a specific sort order for the deal.
possessionDatestring
Possession Date for this deal in date format (YYYY-MM-DD).
teamCommissioninteger
Commission split for the team split, typically as a percentage.
agentCommissioninteger
Commission split for the agent split, typically as a percentage.
commissionValueinteger
Commission value to assign to this deal.
dueDiligenceDatestring
Due Diligence Date for this deal in date format (YYYY-MM-DD).
projectedCloseDatestring
Projected close date of this deal in date format (YYYY-MM-DD). This is the expected date when the deal will be closed.
earnestMoneyDueDatestring
Earnest Money Due Date for this deal in date format (YYYY-MM-DD).
finalWalkThroughDatestring
Final Walk Through Date for this deal in date format (YYYY-MM-DD).
mutualAcceptanceDatestring
Mutual Acceptance Date for this deal in date format (YYYY-MM-DD).

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create Email Marketing CampaignFOLLOW_UP_BOSS_CREATE_EM_CAMPAIGNAcción

Tool to create an email marketing campaign in Follow Up Boss. Use when you need to create a new email campaign with HTML content.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create Email Marketing EventsFOLLOW_UP_BOSS_CREATE_EM_EVENTSAcción

Tool to notify Follow Up Boss about marketing emails sent, opens, clicks, bounces, unsubscribes and spam reports. Use when you need to track email marketing events.

Parámetros de entrada

emEventsobject[]Obligatorio
Array of email marketing event objects. Can send up to 1000 events per request.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create EventsFOLLOW_UP_BOSS_CREATE_EVENTSAcción

Tool 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.

Parámetros de entrada

typestringenum
Event types supported by Follow Up Boss.
RegistrationInquirySeller InquiryProperty InquiryGeneral InquiryViewed PropertySaved PropertyVisited WebsiteIncoming CallUnsubscribedProperty SearchSaved Property Search+2
personobject
Information about the lead who triggered this event.
sourcestring
The name of the lead source
systemstring
The name of the system used in providing leads
messagestring
A message from the user about this inquiry
pageUrlstring
This field is to be used with the 'Viewed Page' event type and indicates the url of the page viewed
campaignobject
Marketing campaign information.
propertyobject
Information about the property this event is related to.
pageTitlestring
This field is to be used with the 'Viewed Page' event type and indicates the title of the page viewed
occurredAtstring
The date this event occurred (format: YYYY-MM-DD). Events older than 1 day are considered historical and won't trigger workflows
descriptionstring
Any additional information about this inquiry
pageDurationinteger
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
pageReferrerstring
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)
propertySearchobject
Information about what the person was searching for.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create GroupFOLLOW_UP_BOSS_CREATE_GROUPSAcción

Tool 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.

Parámetros de entrada

namestringObligatorio
The name of the group.
typestringenum
Type of group defining which user roles can be members.
AgentLender
usersinteger[]Obligatorio
An array of user IDs that will be members of this group.
claimWindowinteger
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).
distributionstringenum
Distribution model for group lead assignment.
first-to-claimround-robin
defaultPondIdinteger
The ID of the pond to assign unclaimed first-to-claim leads to after the claim window expires.
defaultUserIdinteger
The ID of the user to assign unclaimed first-to-claim leads to after the claim window expires.
defaultGroupIdinteger
The ID of the group to assign unclaimed first-to-claim leads to after the claim window expires.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create PipelineFOLLOW_UP_BOSS_CREATE_PIPELINESAcción

Tool 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.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create PondsFOLLOW_UP_BOSS_CREATE_PONDSAcción

Tool 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.

Parámetros de entrada

namestringObligatorio
The name of the pond you want to create
userIdintegerObligatorio
The Pond Lead Agent user ID
userIdsinteger[]Obligatorio
IDs of all users to add as members of the pond

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create ReactionsFOLLOW_UP_BOSS_CREATE_REACTIONSAcción

Tool to add a reaction (emoji) to a Note, Call, or ThreadedReply. Use when you need to add an emoji reaction to existing content.

Parámetros de entrada

bodystringObligatorio
The single-character emoji reaction (e.g., 👍, ❤️, 😀).
refIdintegerObligatorio
The ID of the item that is being reacted to.
refTypestringObligatorioenum
The type of entity that is being reacted to.
NoteCallThreadedReply

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create StageFOLLOW_UP_BOSS_CREATE_STAGEAcción

Tool to create a new stage in Follow Up Boss. Use when you need to add a new pipeline stage for organizing contacts.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create TeamFOLLOW_UP_BOSS_CREATE_TEAMSAcción

Tool to create a new team in Follow Up Boss. Use when you need to organize users into teams with optional team leaders.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create email templateFOLLOW_UP_BOSS_CREATE_TEMPLATEAcción

Tool 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.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create Text Message TemplateFOLLOW_UP_BOSS_CREATE_TEXT_MESSAGE_TEMPLATEAcción

Tool 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.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete AppointmentFOLLOW_UP_BOSS_DELETE_APPOINTMENTAcción

Tool to delete an appointment by ID. Use when you need to remove an existing appointment from Follow Up Boss.

Parámetros de entrada

idintegerObligatorio
The id of appointment to delete.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete Appointment OutcomeFOLLOW_UP_BOSS_DELETE_APPOINTMENT_OUTCOMESAcción

Tool to delete an appointment outcome by ID. Use when you need to remove an appointment outcome and reassign existing appointments to a different outcome.

Parámetros de entrada

idintegerObligatorio
ID of the appointment outcome to delete.
assignOutcomeIdintegerObligatorio
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.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete Appointment TypeFOLLOW_UP_BOSS_DELETE_APPOINTMENT_TYPEAcción

Tool to delete an appointment type by its ID. Use when you need to remove an appointment type and reassign existing appointments to another type.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete Custom FieldFOLLOW_UP_BOSS_DELETE_CUSTOM_FIELDAcción

Tool 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.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete DealFOLLOW_UP_BOSS_DELETE_DEALAcción

Tool to delete a deal by its ID. Use when you need to permanently remove a deal from Follow Up Boss.

Parámetros de entrada

idintegerObligatorio
The id of the deal to delete

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete Deal Custom FieldFOLLOW_UP_BOSS_DELETE_DEAL_CUSTOM_FIELDAcción

Tool 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.

Parámetros de entrada

idintegerObligatorio
The id of the deal custom field to delete.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete GroupFOLLOW_UP_BOSS_DELETE_GROUPSAcción

Tool to delete a group by its ID. Use when you need to permanently remove a group from Follow Up Boss.

Parámetros de entrada

idintegerObligatorio
The ID of the group to delete.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete People RelationshipFOLLOW_UP_BOSS_DELETE_PEOPLE_RELATIONSHIPAcción

Tool to delete a people relationship by ID in Follow Up Boss. Use when you need to remove a relationship between contacts.

Parámetros de entrada

idintegerObligatorio
The relationship ID to delete.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete PipelineFOLLOW_UP_BOSS_DELETE_PIPELINEAcción

Tool 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.

Parámetros de entrada

idintegerObligatorio
The id of the pipeline to delete

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete PondFOLLOW_UP_BOSS_DELETE_PONDAcción

Tool to delete a pond by its ID. Use when removing a pond and reassigning its contacts to another agent.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete StageFOLLOW_UP_BOSS_DELETE_STAGEAcción

Tool to delete a Follow Up Boss stage by ID. Use when you need to remove a stage and reassign action plans to another stage.

Parámetros de entrada

idintegerObligatorio
The id of the stage to delete.
assignStageIdintegerObligatorio
The stage id to assign to action plans referencing the deleted stage.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete TeamFOLLOW_UP_BOSS_DELETE_TEAMSAcción

Tool 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.

Parámetros de entrada

idstringObligatorio
The team id to delete.
moveToTeamIdinteger
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.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete text message templateFOLLOW_UP_BOSS_DELETE_TEXT_MESSAGE_TEMPLATEAcción

Tool 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.

Parámetros de entrada

idintegerObligatorio
The ID of the text message template to delete.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get AppointmentFOLLOW_UP_BOSS_GET_APPOINTMENTAcción

Tool to retrieve an appointment by its ID. Use when you need to fetch details of a specific appointment.

Parámetros de entrada

idintegerObligatorio
The id of the appointment to retrieve.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Appointment OutcomeFOLLOW_UP_BOSS_GET_APPOINTMENT_OUTCOMEAcción

Tool to retrieve an appointment outcome by ID. Use when you need to fetch details about a specific appointment outcome from Follow Up Boss.

Parámetros de entrada

idintegerObligatorio
The id of the appointment outcome.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Appointment TypeFOLLOW_UP_BOSS_GET_APPOINTMENT_TYPESAcción

Tool to retrieve an appointment type by ID. Use when you need to fetch details about a specific appointment type from Follow Up Boss.

Parámetros de entrada

idintegerObligatorio
The id of the appointment type.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get CallFOLLOW_UP_BOSS_GET_CALLAcción

Tool to retrieve a call by its ID from Follow Up Boss. Use when you need to fetch details about a specific call record.

Parámetros de entrada

idintegerObligatorio
The ID of the call to retrieve.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get DealFOLLOW_UP_BOSS_GET_DEALAcción

Tool to retrieve a deal by its ID from Follow Up Boss. Use when you need to fetch details about a specific deal.

Parámetros de entrada

idintegerObligatorio
The id of the deal to retrieve.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Deal Custom FieldFOLLOW_UP_BOSS_GET_DEAL_CUSTOM_FIELDAcción

Tool 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.

Parámetros de entrada

idintegerObligatorio
The id of a deals custom field.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get EventFOLLOW_UP_BOSS_GET_EVENTAcción

Tool to retrieve a single event by its ID from Follow Up Boss. Use when you need to fetch details about a specific event record.

Parámetros de entrada

idintegerObligatorio
The id of the event.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get GroupFOLLOW_UP_BOSS_GET_GROUPSAcción

Tool to retrieve a group by its ID from Follow Up Boss. Use when you need to fetch details about a specific group.

Parámetros de entrada

idintegerObligatorio
The id of the group.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get IdentityFOLLOW_UP_BOSS_GET_IDENTITYAcción

Tool to retrieve identity and authentication information from Follow Up Boss. Use when you need to verify the authenticated user's account and user details.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get MeFOLLOW_UP_BOSS_GET_MEAcción

Tool to retrieve information about the currently authenticated user. Use when you need to fetch details about the authenticated user's account, settings, or permissions.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get People RelationshipFOLLOW_UP_BOSS_GET_PEOPLE_RELATIONSHIPAcción

Tool 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.

Parámetros de entrada

idintegerObligatorio
The ID of a given relationship.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get PipelineFOLLOW_UP_BOSS_GET_PIPELINESAcción

Tool to retrieve a pipeline by its ID from Follow Up Boss. Use when you need to fetch details about a specific pipeline.

Parámetros de entrada

idintegerObligatorio
The id of the pipeline.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get PondsFOLLOW_UP_BOSS_GET_PONDSAcción

Tool to retrieve a pond by its ID from Follow Up Boss. Use when you need to fetch details about a specific pond group.

Parámetros de entrada

idintegerObligatorio
The pond id.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Smart ListFOLLOW_UP_BOSS_GET_SMART_LISTAcción

Tool to retrieve a Smart List by its ID from Follow Up Boss. Use when you need to fetch details about a specific Smart List.

Parámetros de entrada

idintegerObligatorio
The ID of the Smart List to retrieve.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get StageFOLLOW_UP_BOSS_GET_STAGEAcción

Tool to retrieve a stage by its ID from Follow Up Boss. Use when you need to fetch details about a specific stage.

Parámetros de entrada

idintegerObligatorio
The id of the stage to retrieve.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get TeamFOLLOW_UP_BOSS_GET_TEAMSAcción

Tool to retrieve a team by its ID from Follow Up Boss. Use when you need to fetch details about a specific team.

Parámetros de entrada

idintegerObligatorio
The team id.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get TemplateFOLLOW_UP_BOSS_GET_TEMPLATEAcción

Tool 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.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Text MessageFOLLOW_UP_BOSS_GET_TEXT_MESSAGEAcción

Tool 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.

Parámetros de entrada

idintegerObligatorio
The id of the text message record.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Text Message TemplateFOLLOW_UP_BOSS_GET_TEXT_MESSAGE_TEMPLATEAcción

Tool to retrieve a text message template by its ID from Follow Up Boss. Use when you need to fetch details about a specific text message template, including its content, usage statistics, and associated action plans.

Parámetros de entrada

idintegerObligatorio
The ID of the template.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get UserFOLLOW_UP_BOSS_GET_USERAcción

Tool to retrieve a user by its ID from Follow Up Boss. Use when you need to fetch details about a specific user.

Parámetros de entrada

idintegerObligatorio
The ID of a user.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List Action PlansFOLLOW_UP_BOSS_LIST_ACTION_PLANSAcción

Tool 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.

Parámetros de entrada

idsstring
Search for Action Plans by id. Provide a comma-separated list of action plan IDs (e.g., '287564,67484,8436437').
sortstring
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').
limitinteger
Number of results to return. Max 100.
namesstring[]
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.
offsetinteger
Specifies the number of rows to skip before starting to return results.
statusstring
Search for Action Plans with one of the following statuses: 'Active', 'Deleted', or 'Active,Deleted' (if you want both).

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List Action Plans PeopleFOLLOW_UP_BOSS_LIST_ACTION_PLANS_PEOPLEAcción

Tool 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.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List Appointment OutcomesFOLLOW_UP_BOSS_LIST_APPOINTMENT_OUTCOMESAcción

Tool 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.

Parámetros de entrada

sortstring
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`).
limitinteger
Number of results to return. Max 100.
offsetinteger
Specifies the number of rows to skip before starting to return results.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List AppointmentsFOLLOW_UP_BOSS_LIST_APPOINTMENTSAcción

Tool 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.

Parámetros de entrada

endstring
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.
limitinteger
Number of results to return. Maximum 100.
startstring
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.
offsetinteger
Specifies the number of rows to skip before starting to return results.
userIdinteger
Find all appointments related to a user by id.
personIdinteger
Find all appointments related to a person. Note: This can be a single person ID.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List Appointment TypesFOLLOW_UP_BOSS_LIST_APPOINTMENT_TYPESAcción

Tool 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.

Parámetros de entrada

sortstring
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`).
limitinteger
Number of results to return. Max 100.
offsetinteger
Specifies the number of rows to skip before starting to return results.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List CallsFOLLOW_UP_BOSS_LIST_CALLSAcción

Tool 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.

Parámetros de entrada

limitinteger
Number of results to return. Max 100.
phonestring
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.
offsetinteger
Specifies the number of rows to skip before starting to return results.
personIdinteger
Filter calls by a person ID.
toNumberstring
Filter calls based on the number that the call was to.
fromNumberstring
Filter calls based on the number that the call was from.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List Custom FieldsFOLLOW_UP_BOSS_LIST_CUSTOM_FIELDSAcción

Tool 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.

Parámetros de entrada

sortstringenum
Sort field options for custom fields.
id-idname-nameorderWeight-orderWeight
labelstring
Find custom field by label.
limitinteger
Number of results to return. Max 100.
offsetinteger
Specifies the number of rows to skip, before starting to return results.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List Deal Custom FieldsFOLLOW_UP_BOSS_LIST_DEAL_CUSTOM_FIELDSAcción

Tool to list all deal custom fields in Follow Up Boss. Use when you need to retrieve deal custom field definitions, optionally filtered by label or sorted by specific fields.

Parámetros de entrada

sortstringenum
Sort field options for deal custom fields.
id-idname-nameorderWeight-orderWeight
labelstring
Find custom field by label.
limitinteger
Number of results to return. Max 100.
offsetinteger
Specifies the number of rows to skip, before starting to return results.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List DealsFOLLOW_UP_BOSS_LIST_DEALSAcción

Tool 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.

Parámetros de entrada

statusstringenum
Status values for filtering deals.
ActiveArchivedDeleted
userIdinteger
Return a list of deals for a specific user. Filter by user ID.
personIdinteger
Return a list of deals for a specific person. Filter by person ID.
pipelineIdinteger
Return deals for a specific pipeline only. Filter by pipeline ID.
includeDeletedinteger
Set to 1 to include deals with a status of Deleted in the results. Set to 0 or omit to exclude deleted deals.
includeArchivedinteger
Set to 1 to include deals with a status of Archived in the results. Set to 0 or omit to exclude archived deals.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List Email Marketing CampaignsFOLLOW_UP_BOSS_LIST_EM_CAMPAIGNSAcción

Tool to list email marketing campaigns from Follow Up Boss. Use when you need to retrieve all campaigns or filter by origin/originId.

Parámetros de entrada

originstring
Search for campaigns from a specific origin (e.g., 'Mailchimp', 'Campaign Monitor'). If not specified, returns campaigns from all origins.
originIdstring
Search for campaigns with a specific ID from the originating system. Use this to find campaigns by their external system identifier.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List Email Marketing EventsFOLLOW_UP_BOSS_LIST_EM_EVENTSAcción

Tool to retrieve email marketing events from Follow Up Boss. Use when you need to fetch information about marketing emails sent, opens, clicks, bounces, unsubscribes, and spam reports. Supports filtering by event type, person, and time range with pagination.

Parámetros de entrada

typestringenum
Possible types of email marketing events.
deliveredopenclickbouncedsoft-bouncehard-bounceunsubscribespamreportdropped
limitinteger
Number of results to return. Maximum 100.
offsetinteger
Specifies the number of rows to skip before starting to return results.
personIdinteger
Find email marketing events by person ID.
updatedAfterstring
Find email marketing events that have been created or updated after the specified time. Use ISO 8601 format.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List EventsFOLLOW_UP_BOSS_LIST_EVENTSAcción

Tool 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.

Parámetros de entrada

nextstring
To get the next page of results, set this to the value returned in _metadata.next, or use the URL from _metadata.nextLink directly.
typestring
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'.
limitinteger
Number of results to return. Max 100.
offsetinteger
Specifies the number of rows to skip, before starting to return results. (For more efficient paging, please use the 'next' parameter instead.)
personIdinteger
Find all events related to a person.
hasPropertyboolean
Filters based on whether a property is associated with an event or not.
propertyAddressstring
Searches property addresses for a given value, including partial matches.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List GroupsFOLLOW_UP_BOSS_LIST_GROUPSAcción

Tool 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.

Parámetros de entrada

sortstringenum
Sort field options for groups.
id-idname-name
typestringenum
Type of group.
AgentLender

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List Groups Round RobinFOLLOW_UP_BOSS_LIST_GROUPS_ROUND_ROBINAcción

Tool to list groups with round-robin data from Follow Up Boss. Use when you need to retrieve groups configured for round-robin distribution.

Parámetros de entrada

sortstringenum
Enum for sort field values.
idname-id-name
typestringenum
Enum for group type values.
AgentLender

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List Inbox AppsFOLLOW_UP_BOSS_LIST_INBOX_APPSAcción

Tool 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.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List People RelationshipsFOLLOW_UP_BOSS_LIST_PEOPLE_RELATIONSHIPSAcción

Tool to list all people relationships from Follow Up Boss. Use when you need to retrieve relationships between contacts with optional filtering by person ID, name, or first/last name, and sorting capabilities.

Parámetros de entrada

namestring
Searches for person with a name like what is given. (e.g., If you search for `drew`, it might return a contact like `Andrew`.)
sortstring
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`).
lastNamestring
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.`)
personIdinteger
Filter relationships by a person ID.
firstNamestring
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.`)

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List PipelinesFOLLOW_UP_BOSS_LIST_PIPELINESAcción

Tool to search for pipelines in Follow Up Boss. Use when you need to retrieve a list of pipelines, optionally filtering by exact name match.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List PondsFOLLOW_UP_BOSS_LIST_PONDSAcción

Tool to list all ponds from Follow Up Boss. Use when you need to retrieve a list of pond groups with pagination support.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List Smart ListsFOLLOW_UP_BOSS_LIST_SMART_LISTSAcción

Tool 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.

Parámetros de entrada

allboolean
Use this parameter to show all smart lists, whether from FUB Classic or FUB.
fub2boolean
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.
limitinteger
Number of results to return. Max 100.
offsetinteger
Specifies the number of rows to skip before starting to return results.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List StagesFOLLOW_UP_BOSS_LIST_STAGESAcción

Tool to retrieve a list of stages from Follow Up Boss. Use when you need to fetch all stages with optional pagination and sorting.

Parámetros de entrada

sortstringenum
Sort options for listing stages.
orderWeightidname
limitinteger
Number of results to return. Max 100.
offsetinteger
Specifies the number of rows to skip before starting to return results.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List Team InboxesFOLLOW_UP_BOSS_LIST_TEAM_INBOXESAcción

Tool 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.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List TeamsFOLLOW_UP_BOSS_LIST_TEAMSAcción

Tool 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.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List TemplatesFOLLOW_UP_BOSS_LIST_TEMPLATESAcción

Tool to list all email templates from Follow Up Boss. Use when you need to retrieve multiple email templates with pagination support.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List Text MessagesFOLLOW_UP_BOSS_LIST_TEXT_MESSAGESAcción

Tool 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.

Parámetros de entrada

idstring
Filter by specific text message ID(s).
phonestring
Filter by phone number.
personIdinteger
Filter text messages for a specific person id only. Note: At least one filter parameter must be provided.
threadIdinteger
Filter by thread ID.
toNumberstring
Filter text messages sent to a specific recipient's phone number.
fromNumberstring
Filter text messages sent from a specific sender's phone number.
groupTextIdinteger
Filter by group text ID.
participantsstring
Filter by participants.
sharedInboxIdinteger
Filter by shared inbox ID.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List Text Message TemplatesFOLLOW_UP_BOSS_LIST_TEXT_MESSAGE_TEMPLATESAcción

Tool to list all text message templates from Follow Up Boss. Use when you need to retrieve multiple text message templates with pagination support.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List TimeframesFOLLOW_UP_BOSS_LIST_TIMEFRAMESAcción

Tool to get a list of timeframes from Follow Up Boss. Use when you need to retrieve available timeframes.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List UsersFOLLOW_UP_BOSS_LIST_USERSAcción

Tool 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.

Parámetros de entrada

namestring
Find a user by their full name. Exact matches only, no partial matching available.
rolestring
Find users by a specific role (e.g., 'Broker', 'Agent', 'Lender').
sortstring
Field to sort by. Currently only 'id', 'name' and 'created' are available.
emailstring
Find a user by their email address.
limitinteger
Number of results to return. Max 100.
fieldsstring
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).
offsetinteger
Specifies the number of rows to skip before starting to return results.
includeDeletedboolean
Setting this to true will include users that have been deleted.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List WebhooksFOLLOW_UP_BOSS_LIST_WEBHOOKSAcción

Tool 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.

Parámetros de entrada

sortstringenum
Sort order options for webhooks.
idcreatedupdatedstatusevent
eventstring
Search for webhooks by event (e.g., 'peopleCreated' or 'peopleUpdated').
limitinteger
Number of results to return. Max 100.
offsetinteger
Specifies the number of rows to skip before starting to return results.
statusstringenum
Status values for filtering webhooks.
ActiveDisabled
X-Systemstring
The name of the registered system.
X-System-Keystring
The key of the registered system.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Merge TemplateFOLLOW_UP_BOSS_MERGE_TEMPLATEAcción

Tool 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.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Merge Text Message TemplateFOLLOW_UP_BOSS_MERGE_TEXT_MESSAGE_TEMPLATEAcción

Tool 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.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update Action Plan People StatusFOLLOW_UP_BOSS_UPDATE_ACTION_PLANS_PEOPLEAcción

Tool 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.

Parámetros de entrada

idintegerObligatorio
The ID of the Action Plan People object to update.
statusstringObligatorioenum
The desired state of the applied action plan. Either 'Running' or 'Paused'.
RunningPaused

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update AppointmentFOLLOW_UP_BOSS_UPDATE_APPOINTMENTAcción

Tool 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.

Parámetros de entrada

idintegerObligatorio
The id of the appointment to update.
endstringObligatorio
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').
startstringObligatorio
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').
titlestringObligatorio
Title of the appointment.
allDayboolean
Sets whether the appointment is an all day event or not.
typeIdinteger
The Follow Up Boss appointment type identifier.
inviteesobject[]
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.
locationstring
The location or address of the appointment.
outcomeIdinteger
The Follow Up Boss appointment outcome identifier.
descriptionstring
Description of the appointment or event.
sendInvitationboolean
Send an invitation email to invitees. If the 'appointment reminders' feature is enabled, an SMS reminder will also be sent. Defaults to false.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update appointment outcomeFOLLOW_UP_BOSS_UPDATE_APPOINTMENT_OUTCOMESAcción

Tool 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.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update Appointment TypeFOLLOW_UP_BOSS_UPDATE_APPOINTMENT_TYPESAcción

Tool 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.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update CallFOLLOW_UP_BOSS_UPDATE_CALLSAcción

Tool 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.

Parámetros de entrada

idintegerObligatorio
The ID of the call to update.
notestring
The log message entered for this call.
phonestring
The phone number this call was made to or from.
userIdinteger
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.
outcomestringenum
Possible outcomes for a call.
InterestedNot InterestedLeft MessageNo AnswerBusyBad Number
durationinteger
Length of the call in seconds.
personIdinteger
The ID of a person associated with this call.
toNumberstring
The phone number this call was made to.
fromNumberstring
The phone number this call was made from.
isIncomingboolean
Sets this as an incoming or outgoing call.
recordingUrlstring
The URL for the call recording.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update Custom FieldsFOLLOW_UP_BOSS_UPDATE_CUSTOM_FIELDSAcción

Tool 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.

Parámetros de entrada

idintegerObligatorio
The ID of the custom field to update. Must be a valid custom field ID.
labelstring
The user-friendly name of the custom field (e.g., "Anniversary", "Customer Type"). This is the label that will be displayed in the UI.
choicesstring[]
Array of options related to a custom field of type 'dropdown'. Each string represents one selectable option. Only applicable for dropdown type fields.
hideIfEmptyboolean
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.
isRecurringboolean
Sets whether a date field occurs every year (e.g., birthdays, anniversaries, etc.). Only applicable for 'date' type custom fields. Defaults to false.
orderWeightinteger
A weighted integer for the field to assign values for custom sorting. Higher values appear later in the list. Defaults to 0.
dropdownChoiceMaparray
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.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update Deal Custom FieldsFOLLOW_UP_BOSS_UPDATE_DEAL_CUSTOM_FIELDSAcción

Tool 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.

Parámetros de entrada

idintegerObligatorio
The id of the deals custom field to update.
typestringObligatorioenum
The type of deal custom field.
textdatenumberdropdown
labelstringObligatorio
The user-friendly name of the custom field (e.g., 'Anniversary', 'Deal Stage').
choicesstring[]
Array of options related to a deals custom field of type 'dropdown'. Required when type is 'dropdown', ignored otherwise.
readOnlyboolean
Determines whether the deal custom field is read-only. Defaults to false.
hideIfEmptyboolean
Sets whether to hide this field if it is empty. Defaults to false.
isRecurringboolean
Whether a date field occurs every year (e.g. birthdays, anniversaries). Only applicable when type is 'date'. Defaults to false.
orderWeightinteger
A weighted integer for custom sorting of fields. Higher weights appear later. Defaults to 0.
dropdownChoiceMapinteger[]
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.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update DealFOLLOW_UP_BOSS_UPDATE_DEALSAcción

Tool 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.

Parámetros de entrada

idintegerObligatorio
The id of the deal to update. This is a required field.
namestring
Name of the deal.
priceinteger
The price associated with this deal.
stageIdinteger
The stage that this deal should be assigned to.
userIdsinteger[]
A list of user ids that should be part of this deal.
peopleIdsinteger[]
A list of person ids that should be part of this deal.
descriptionstring
Description of the deal.
possessionDatestring
Possession Date for this deal in date format (YYYY-MM-DD).
teamCommissioninteger
Commission value for a team split.
agentCommissioninteger
Commission value for an agent split.
commissionValueinteger
Commission value to assign to this deal.
dueDiligenceDatestring
Due Diligence Date for this deal in date format (YYYY-MM-DD).
projectedCloseDatestring
Projected close date of this deal in date format (YYYY-MM-DD).
earnestMoneyDueDatestring
Earnest Money Due Date for this deal in date format (YYYY-MM-DD).
finalWalkThroughDatestring
Final Walk Through Date for this deal in date format (YYYY-MM-DD).
mutualAcceptanceDatestring
Mutual Acceptance Date for this deal in date format (YYYY-MM-DD).

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update Email Marketing CampaignFOLLOW_UP_BOSS_UPDATE_EM_CAMPAIGNSAcción

Tool 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.

Parámetros de entrada

idintegerObligatorio
Follow Up Boss ID of the email campaign to update.
namestring
Name of the email campaign or template.
subjectstring
Email subject line.
bodyHtmlstring
Email body in HTML format.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update GroupFOLLOW_UP_BOSS_UPDATE_GROUPSAcción

Tool to update an existing Follow Up Boss group with modified members and distribution settings. Use when you need to change group configuration or membership.

Parámetros de entrada

idintegerObligatorio
The id of the group to update.
namestringObligatorio
The name of the group.
typestringenum
Type of group defining which user roles can be members.
AgentLender
usersinteger[]Obligatorio
An array of user IDs that will be members of this group.
claimWindowinteger
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).
distributionstringenum
Distribution model for group lead assignment.
first-to-claimround-robin
defaultPondIdinteger
The ID of the pond to assign unclaimed first-to-claim leads to after the claim window expires.
defaultUserIdinteger
The ID of the user to assign unclaimed first-to-claim leads to after the claim window expires.
defaultGroupIdinteger
The ID of the group to assign unclaimed first-to-claim leads to after the claim window expires.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update People RelationshipsFOLLOW_UP_BOSS_UPDATE_PEOPLE_RELATIONSHIPSAcción

Tool 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.

Parámetros de entrada

idintegerObligatorio
The ID of a given relationship.
typestring
The type of relationship (e.g., Spouse, Brother, Partner, etc.).
emailsobject[]
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.
phonesobject[]
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.
lastNamestring
The last/family name of the relationship.
addressesobject[]
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.
firstNamestring
The first/given name of the relationship.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update PipelineFOLLOW_UP_BOSS_UPDATE_PIPELINESAcción

Tool 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.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update PondsFOLLOW_UP_BOSS_UPDATE_PONDSAcción

Tool 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.

Parámetros de entrada

idintegerObligatorio
The pond id.
namestring
Set this value to change the name of the Pond
userIdinteger
Set this value to change the Pond Lead Agent
userIdsinteger[]
Set this value to add or remove members from the pond

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update StageFOLLOW_UP_BOSS_UPDATE_STAGESAcción

Tool to update an existing stage in Follow Up Boss. Use when you need to modify stage properties like name or sort order.

Parámetros de entrada

idintegerObligatorio
The id of the stage to update.
namestring
Name of the stage.
orderWeightinteger
Helps to set a specific sort order. Higher values appear later in the list.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update TeamFOLLOW_UP_BOSS_UPDATE_TEAMSAcción

Tool to update an existing team in Follow Up Boss. Use when you need to modify team name, leaders, or members.

Parámetros de entrada

idintegerObligatorio
The team id to update.
namestring
The team name.
userIdsinteger[]
The complete list of members of this team. If provided, this replaces all existing members.
leaderIdsinteger[]
The complete list of team leaders. If provided, this replaces all existing leaders.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update email templateFOLLOW_UP_BOSS_UPDATE_TEMPLATESAcción

Tool to update an existing email template in Follow Up Boss. Use when you need to modify the name, subject, or body of an existing template.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update Text Message TemplateFOLLOW_UP_BOSS_UPDATE_TEXT_MESSAGE_TEMPLATEAcción

Tool to update an existing text message template in Follow Up Boss. Use when you need to modify the name, message content, or sharing settings of an existing SMS template.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not