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

- **Category:** crm
- **Auth:** API_KEY, OAUTH2
- **Composio Managed App Available?** No
- **Tools:** 99
- **Triggers:** 0
- **Slug:** `FOLLOW_UP_BOSS`
- **Version:** 20260312_00

## Tools

### Apply Action Plan to Person

**Slug:** `FOLLOW_UP_BOSS_CREATE_ACTION_PLANS_PEOPLE`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `personId` | integer | Yes | The ID of the person to whom you would like to apply the action plan. |
| `actionPlanId` | integer | Yes | The ID of the action plan to apply |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Appointment

**Slug:** `FOLLOW_UP_BOSS_CREATE_APPOINTMENT`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `end` | string | Yes | 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'). |
| `start` | string | Yes | 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'). |
| `title` | string | Yes | Title of the appointment. |
| `allDay` | boolean | No | Sets whether the appointment is an all day event or not. Defaults to false. |
| `typeId` | integer | No | The Follow Up Boss appointment type identifier. |
| `invitees` | array | No | 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. |
| `location` | string | No | The location or address of the appointment. |
| `outcomeId` | integer | No | The Follow Up Boss appointment outcome identifier. |
| `createdById` | integer | No | 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. |
| `description` | string | No | Description of the appointment or event. |
| `sendInvitation` | boolean | No | Send an invitation email to invitees. If the 'appointment reminders' feature is enabled, an SMS reminder will also be sent. Defaults to false. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create appointment outcome

**Slug:** `FOLLOW_UP_BOSS_CREATE_APPOINTMENT_OUTCOME`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Name of the appointment outcome. |
| `orderWeight` | integer | No | Set this value to enforce a specific sort order. Higher values appear later in the list. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Appointment Type

**Slug:** `FOLLOW_UP_BOSS_CREATE_APPOINTMENT_TYPES`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | The name of the appointment type. |
| `orderWeight` | integer | No | Set this value to enforce a specific sort order. Higher values appear later in the list. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Call

**Slug:** `FOLLOW_UP_BOSS_CREATE_CALL`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `note` | string | No | The log message entered for this call. |
| `phone` | string | Yes | The phone number this call was made to or from. |
| `userId` | integer | No | 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. |
| `outcome` | string ("Interested" | "Not Interested" | "Left Message" | "No Answer" | "Busy" | "Bad Number") | No | Possible outcomes for a call. |
| `duration` | integer | No | Length of the call in seconds. |
| `personId` | integer | Yes | The ID of a person associated with this call. |
| `toNumber` | string | No | The phone number this call was made to. |
| `fromNumber` | string | No | The phone number this call was made from. |
| `isIncoming` | boolean | Yes | Sets this as an incoming or outgoing call. |
| `recordingUrl` | string | No | The URL for the call recording. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Custom Field

**Slug:** `FOLLOW_UP_BOSS_CREATE_CUSTOM_FIELD`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `type` | string ("text" | "date" | "number" | "dropdown") | Yes | 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. |
| `label` | string | Yes | The user-friendly name of the custom field (e.g., "Anniversary", "Customer Type"). This is the label that will be displayed in the UI. |
| `choices` | array | No | 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. |
| `hideIfEmpty` | boolean | No | 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. |
| `isRecurring` | boolean | No | Whether a date field occurs every year (e.g., birthdays, anniversaries). Only applicable for 'date' type custom fields. Defaults to false. |
| `orderWeight` | integer | No | A weighted integer used for custom sorting of fields. Higher values appear later in the list. Defaults to 0. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Deal Custom Field

**Slug:** `FOLLOW_UP_BOSS_CREATE_DEAL_CUSTOM_FIELD`

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.

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Deal

**Slug:** `FOLLOW_UP_BOSS_CREATE_DEALS`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Name of the deal. This is a required field that identifies the deal. |
| `price` | integer | No | The price associated with this deal in cents or as an integer value. |
| `stageId` | integer | Yes | 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. |
| `userIds` | array | No | A list of user IDs that should be part of this deal. |
| `peopleIds` | array | No | A list of person IDs that should be part of this deal. |
| `description` | string | No | Description of the deal. Provides additional context or notes about the deal. |
| `orderWeight` | integer | No | Set this value to enforce a specific sort order for the deal. |
| `possessionDate` | string | No | Possession Date for this deal in date format (YYYY-MM-DD). |
| `teamCommission` | integer | No | Commission split for the team split, typically as a percentage. |
| `agentCommission` | integer | No | Commission split for the agent split, typically as a percentage. |
| `commissionValue` | integer | No | Commission value to assign to this deal. |
| `dueDiligenceDate` | string | No | Due Diligence Date for this deal in date format (YYYY-MM-DD). |
| `projectedCloseDate` | string | No | Projected close date of this deal in date format (YYYY-MM-DD). This is the expected date when the deal will be closed. |
| `earnestMoneyDueDate` | string | No | Earnest Money Due Date for this deal in date format (YYYY-MM-DD). |
| `finalWalkThroughDate` | string | No | Final Walk Through Date for this deal in date format (YYYY-MM-DD). |
| `mutualAcceptanceDate` | string | No | Mutual Acceptance Date for this deal in date format (YYYY-MM-DD). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Email Marketing Campaign

**Slug:** `FOLLOW_UP_BOSS_CREATE_EM_CAMPAIGN`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Name of the email campaign or template. |
| `origin` | string | Yes | Name of the email marketing system where this campaign originated from. |
| `subject` | string | Yes | Email subject line. |
| `bodyHtml` | string | Yes | Email body in HTML format. Must be valid HTML. |
| `originId` | string | Yes | Internal ID of the new campaign or email in the origin system. Must be unique. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Email Marketing Events

**Slug:** `FOLLOW_UP_BOSS_CREATE_EM_EVENTS`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `emEvents` | array | Yes | Array of email marketing event objects. Can send up to 1000 events per request. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Events

**Slug:** `FOLLOW_UP_BOSS_CREATE_EVENTS`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `type` | 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") | No | Event types supported by Follow Up Boss. |
| `person` | object | No | Information about the lead who triggered this event. |
| `source` | string | No | The name of the lead source |
| `system` | string | No | The name of the system used in providing leads |
| `message` | string | No | A message from the user about this inquiry |
| `pageUrl` | string | No | This field is to be used with the 'Viewed Page' event type and indicates the url of the page viewed |
| `campaign` | object | No | Marketing campaign information. |
| `property` | object | No | Information about the property this event is related to. |
| `pageTitle` | string | No | This field is to be used with the 'Viewed Page' event type and indicates the title of the page viewed |
| `occurredAt` | string | No | The date this event occurred (format: YYYY-MM-DD). Events older than 1 day are considered historical and won't trigger workflows |
| `description` | string | No | Any additional information about this inquiry |
| `pageDuration` | integer | No | 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 |
| `pageReferrer` | string | No | 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) |
| `propertySearch` | object | No | Information about what the person was searching for. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Group

**Slug:** `FOLLOW_UP_BOSS_CREATE_GROUPS`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | The name of the group. |
| `type` | string ("Agent" | "Lender") | No | Type of group defining which user roles can be members. |
| `users` | array | Yes | An array of user IDs that will be members of this group. |
| `claimWindow` | integer | No | 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). |
| `distribution` | string ("first-to-claim" | "round-robin") | No | Distribution model for group lead assignment. |
| `defaultPondId` | integer | No | The ID of the pond to assign unclaimed first-to-claim leads to after the claim window expires. |
| `defaultUserId` | integer | No | The ID of the user to assign unclaimed first-to-claim leads to after the claim window expires. |
| `defaultGroupId` | integer | No | The ID of the group to assign unclaimed first-to-claim leads to after the claim window expires. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Pipeline

**Slug:** `FOLLOW_UP_BOSS_CREATE_PIPELINES`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | The name of the pipeline. |
| `stages` | array | No | An array of stage objects that should be associated with the pipeline. Each stage must have a name and closedStage indicator. |
| `description` | string | No | Description of the pipeline. |
| `orderWeight` | integer | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Ponds

**Slug:** `FOLLOW_UP_BOSS_CREATE_PONDS`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | The name of the pond you want to create |
| `userId` | integer | Yes | The Pond Lead Agent user ID |
| `userIds` | array | Yes | IDs of all users to add as members of the pond |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Reactions

**Slug:** `FOLLOW_UP_BOSS_CREATE_REACTIONS`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | string | Yes | The single-character emoji reaction (e.g., 👍, ❤️, 😀). |
| `refId` | integer | Yes | The ID of the item that is being reacted to. |
| `refType` | string ("Note" | "Call" | "ThreadedReply") | Yes | The type of entity that is being reacted to. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Stage

**Slug:** `FOLLOW_UP_BOSS_CREATE_STAGE`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Name of the stage. |
| `orderWeight` | integer | No | Set this value to enforce a specific sort order. Higher values appear later in the list. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Team

**Slug:** `FOLLOW_UP_BOSS_CREATE_TEAMS`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | The name of the team. |
| `userIds` | array | Yes | An array of user IDs that will be members of this team. At least one user ID is required. |
| `leaderIds` | array | No | The complete list of team leaders. Optional. If not provided, the team will have no leaders. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create email template

**Slug:** `FOLLOW_UP_BOSS_CREATE_TEMPLATE`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | string | Yes | The HTML body of the email template. |
| `name` | string | Yes | The name of the new email template. |
| `subject` | string | Yes | The email subject used when this email template is selected. |
| `isShared` | boolean | No | Indicates whether this email template should be shared with other users in the same Follow Up Boss account. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Text Message Template

**Slug:** `FOLLOW_UP_BOSS_CREATE_TEXT_MESSAGE_TEMPLATE`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | The name of your text message template. |
| `message` | string | Yes | The body of your text message template. Can include variables like %greeting_time%, %contact_first_name%. |
| `isShared` | boolean | No | Set to true if this template should be shared with other users in the same Follow Up Boss account. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Appointment

**Slug:** `FOLLOW_UP_BOSS_DELETE_APPOINTMENT`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | The id of appointment to delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Appointment Outcome

**Slug:** `FOLLOW_UP_BOSS_DELETE_APPOINTMENT_OUTCOMES`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | ID of the appointment outcome to delete. |
| `assignOutcomeId` | integer | Yes | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Appointment Type

**Slug:** `FOLLOW_UP_BOSS_DELETE_APPOINTMENT_TYPE`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | The id of the appointment type to delete. |
| `assignTypeId` | integer | Yes | The typeId to reassign existing appointments to before deleting this appointment type. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Custom Field

**Slug:** `FOLLOW_UP_BOSS_DELETE_CUSTOM_FIELD`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The ID of the custom field to delete. Must be a valid custom field ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Deal

**Slug:** `FOLLOW_UP_BOSS_DELETE_DEAL`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | The id of the deal to delete |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Deal Custom Field

**Slug:** `FOLLOW_UP_BOSS_DELETE_DEAL_CUSTOM_FIELD`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | The id of the deal custom field to delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Group

**Slug:** `FOLLOW_UP_BOSS_DELETE_GROUPS`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | The ID of the group to delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete People Relationship

**Slug:** `FOLLOW_UP_BOSS_DELETE_PEOPLE_RELATIONSHIP`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | The relationship ID to delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Pipeline

**Slug:** `FOLLOW_UP_BOSS_DELETE_PIPELINE`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | The id of the pipeline to delete |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Pond

**Slug:** `FOLLOW_UP_BOSS_DELETE_POND`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | The pond id to delete. |
| `assignTo` | integer | Yes | Select which agent should receive any contacts currently in this pond after it is deleted. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Stage

**Slug:** `FOLLOW_UP_BOSS_DELETE_STAGE`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | The id of the stage to delete. |
| `assignStageId` | integer | Yes | The stage id to assign to action plans referencing the deleted stage. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Team

**Slug:** `FOLLOW_UP_BOSS_DELETE_TEAMS`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The team id to delete. |
| `moveToTeamId` | integer | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete text message template

**Slug:** `FOLLOW_UP_BOSS_DELETE_TEXT_MESSAGE_TEMPLATE`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | The ID of the text message template to delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Appointment

**Slug:** `FOLLOW_UP_BOSS_GET_APPOINTMENT`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | The id of the appointment to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Appointment Outcome

**Slug:** `FOLLOW_UP_BOSS_GET_APPOINTMENT_OUTCOME`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | The id of the appointment outcome. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Appointment Type

**Slug:** `FOLLOW_UP_BOSS_GET_APPOINTMENT_TYPES`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | The id of the appointment type. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Call

**Slug:** `FOLLOW_UP_BOSS_GET_CALL`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | The ID of the call to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Deal

**Slug:** `FOLLOW_UP_BOSS_GET_DEAL`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | The id of the deal to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Deal Custom Field

**Slug:** `FOLLOW_UP_BOSS_GET_DEAL_CUSTOM_FIELD`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | The id of a deals custom field. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Event

**Slug:** `FOLLOW_UP_BOSS_GET_EVENT`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | The id of the event. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Group

**Slug:** `FOLLOW_UP_BOSS_GET_GROUPS`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | The id of the group. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Identity

**Slug:** `FOLLOW_UP_BOSS_GET_IDENTITY`

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.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Me

**Slug:** `FOLLOW_UP_BOSS_GET_ME`

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.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get People Relationship

**Slug:** `FOLLOW_UP_BOSS_GET_PEOPLE_RELATIONSHIP`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | The ID of a given relationship. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Pipeline

**Slug:** `FOLLOW_UP_BOSS_GET_PIPELINES`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | The id of the pipeline. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Ponds

**Slug:** `FOLLOW_UP_BOSS_GET_PONDS`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | The pond id. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Smart List

**Slug:** `FOLLOW_UP_BOSS_GET_SMART_LIST`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | The ID of the Smart List to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Stage

**Slug:** `FOLLOW_UP_BOSS_GET_STAGE`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | The id of the stage to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Team

**Slug:** `FOLLOW_UP_BOSS_GET_TEAMS`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | The team id. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Template

**Slug:** `FOLLOW_UP_BOSS_GET_TEMPLATE`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | The ID of the template to retrieve. |
| `mergePersonId` | integer | No | When specified, the returned template will have its merge fields filled out with the specified person record and the current user record. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Text Message

**Slug:** `FOLLOW_UP_BOSS_GET_TEXT_MESSAGE`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | The id of the text message record. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Text Message Template

**Slug:** `FOLLOW_UP_BOSS_GET_TEXT_MESSAGE_TEMPLATE`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | The ID of the template. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get User

**Slug:** `FOLLOW_UP_BOSS_GET_USER`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | The ID of a user. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Action Plans

**Slug:** `FOLLOW_UP_BOSS_LIST_ACTION_PLANS`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `ids` | string | No | Search for Action Plans by id. Provide a comma-separated list of action plan IDs (e.g., '287564,67484,8436437'). |
| `sort` | string | No | 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'). |
| `limit` | integer | No | Number of results to return. Max 100. |
| `names` | array | No | 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. |
| `offset` | integer | No | Specifies the number of rows to skip before starting to return results. |
| `status` | string | No | Search for Action Plans with one of the following statuses: 'Active', 'Deleted', or 'Active,Deleted' (if you want both). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Action Plans People

**Slug:** `FOLLOW_UP_BOSS_LIST_ACTION_PLANS_PEOPLE`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Number of results to return. Max 100. |
| `offset` | integer | No | Specifies the number of rows to skip before starting to return results. |
| `personId` | integer | No | List Action Plans applied to a specified person. |
| `actionPlanId` | integer | No | List People on the specified Action Plan. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Appointment Outcomes

**Slug:** `FOLLOW_UP_BOSS_LIST_APPOINTMENT_OUTCOMES`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sort` | string | No | 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`). |
| `limit` | integer | No | Number of results to return. Max 100. |
| `offset` | integer | No | Specifies the number of rows to skip before starting to return results. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Appointments

**Slug:** `FOLLOW_UP_BOSS_LIST_APPOINTMENTS`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `end` | string | No | 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. |
| `limit` | integer | No | Number of results to return. Maximum 100. |
| `start` | string | No | 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. |
| `offset` | integer | No | Specifies the number of rows to skip before starting to return results. |
| `userId` | integer | No | Find all appointments related to a user by id. |
| `personId` | integer | No | Find all appointments related to a person. Note: This can be a single person ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Appointment Types

**Slug:** `FOLLOW_UP_BOSS_LIST_APPOINTMENT_TYPES`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sort` | string | No | 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`). |
| `limit` | integer | No | Number of results to return. Max 100. |
| `offset` | integer | No | Specifies the number of rows to skip before starting to return results. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Calls

**Slug:** `FOLLOW_UP_BOSS_LIST_CALLS`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Number of results to return. Max 100. |
| `phone` | string | No | 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. |
| `offset` | integer | No | Specifies the number of rows to skip before starting to return results. |
| `personId` | integer | No | Filter calls by a person ID. |
| `toNumber` | string | No | Filter calls based on the number that the call was to. |
| `fromNumber` | string | No | Filter calls based on the number that the call was from. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Custom Fields

**Slug:** `FOLLOW_UP_BOSS_LIST_CUSTOM_FIELDS`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sort` | string ("id" | "-id" | "name" | "-name" | "orderWeight" | "-orderWeight") | No | Sort field options for custom fields. |
| `label` | string | No | Find custom field by label. |
| `limit` | integer | No | Number of results to return. Max 100. |
| `offset` | integer | No | Specifies the number of rows to skip, before starting to return results. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Deal Custom Fields

**Slug:** `FOLLOW_UP_BOSS_LIST_DEAL_CUSTOM_FIELDS`

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.

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Deals

**Slug:** `FOLLOW_UP_BOSS_LIST_DEALS`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `status` | string ("Active" | "Archived" | "Deleted") | No | Status values for filtering deals. |
| `userId` | integer | No | Return a list of deals for a specific user. Filter by user ID. |
| `personId` | integer | No | Return a list of deals for a specific person. Filter by person ID. |
| `pipelineId` | integer | No | Return deals for a specific pipeline only. Filter by pipeline ID. |
| `includeDeleted` | integer | No | Set to 1 to include deals with a status of Deleted in the results. Set to 0 or omit to exclude deleted deals. |
| `includeArchived` | integer | No | Set to 1 to include deals with a status of Archived in the results. Set to 0 or omit to exclude archived deals. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Email Marketing Campaigns

**Slug:** `FOLLOW_UP_BOSS_LIST_EM_CAMPAIGNS`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `origin` | string | No | Search for campaigns from a specific origin (e.g., 'Mailchimp', 'Campaign Monitor'). If not specified, returns campaigns from all origins. |
| `originId` | string | No | Search for campaigns with a specific ID from the originating system. Use this to find campaigns by their external system identifier. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Email Marketing Events

**Slug:** `FOLLOW_UP_BOSS_LIST_EM_EVENTS`

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.

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Events

**Slug:** `FOLLOW_UP_BOSS_LIST_EVENTS`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `next` | string | No | To get the next page of results, set this to the value returned in _metadata.next, or use the URL from _metadata.nextLink directly. |
| `type` | string | No | 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'. |
| `limit` | integer | No | Number of results to return. Max 100. |
| `offset` | integer | No | Specifies the number of rows to skip, before starting to return results. (For more efficient paging, please use the 'next' parameter instead.) |
| `personId` | integer | No | Find all events related to a person. |
| `hasProperty` | boolean | No | Filters based on whether a property is associated with an event or not. |
| `propertyAddress` | string | No | Searches property addresses for a given value, including partial matches. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Groups

**Slug:** `FOLLOW_UP_BOSS_LIST_GROUPS`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sort` | string ("id" | "-id" | "name" | "-name") | No | Sort field options for groups. |
| `type` | string ("Agent" | "Lender") | No | Type of group. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Groups Round Robin

**Slug:** `FOLLOW_UP_BOSS_LIST_GROUPS_ROUND_ROBIN`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sort` | string ("id" | "name" | "-id" | "-name") | No | Enum for sort field values. |
| `type` | string ("Agent" | "Lender") | No | Enum for group type values. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Inbox Apps

**Slug:** `FOLLOW_UP_BOSS_LIST_INBOX_APPS`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Number of results to return. Max 100. |
| `offset` | integer | No | Specifies the number of rows to skip before starting to return results. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List People Relationships

**Slug:** `FOLLOW_UP_BOSS_LIST_PEOPLE_RELATIONSHIPS`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Searches for person with a name like what is given. (e.g., If you search for `drew`, it might return a contact like `Andrew`.) |
| `sort` | string | No | 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`). |
| `lastName` | string | No | 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.`) |
| `personId` | integer | No | Filter relationships by a person ID. |
| `firstName` | string | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Pipelines

**Slug:** `FOLLOW_UP_BOSS_LIST_PIPELINES`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | The pipeline name to lookup. (Must be an exact match.) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Ponds

**Slug:** `FOLLOW_UP_BOSS_LIST_PONDS`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Number of results to return. Max 100. |
| `offset` | integer | No | Specifies the number of rows to skip before starting to return results. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Smart Lists

**Slug:** `FOLLOW_UP_BOSS_LIST_SMART_LISTS`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `all` | boolean | No | Use this parameter to show all smart lists, whether from FUB Classic or FUB. |
| `fub2` | boolean | No | 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. |
| `limit` | integer | No | Number of results to return. Max 100. |
| `offset` | integer | No | Specifies the number of rows to skip before starting to return results. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Stages

**Slug:** `FOLLOW_UP_BOSS_LIST_STAGES`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sort` | string ("orderWeight" | "id" | "name") | No | Sort options for listing stages. |
| `limit` | integer | No | Number of results to return. Max 100. |
| `offset` | integer | No | Specifies the number of rows to skip before starting to return results. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Team Inboxes

**Slug:** `FOLLOW_UP_BOSS_LIST_TEAM_INBOXES`

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.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Teams

**Slug:** `FOLLOW_UP_BOSS_LIST_TEAMS`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Number of results to return. Max 100. |
| `offset` | integer | No | Specifies the number of rows to skip before starting to return results. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Templates

**Slug:** `FOLLOW_UP_BOSS_LIST_TEMPLATES`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Number of results to return. Max 100. |
| `offset` | integer | No | Specifies the number of rows to skip before starting to return results. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Text Messages

**Slug:** `FOLLOW_UP_BOSS_LIST_TEXT_MESSAGES`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | No | Filter by specific text message ID(s). |
| `phone` | string | No | Filter by phone number. |
| `personId` | integer | No | Filter text messages for a specific person id only. Note: At least one filter parameter must be provided. |
| `threadId` | integer | No | Filter by thread ID. |
| `toNumber` | string | No | Filter text messages sent to a specific recipient's phone number. |
| `fromNumber` | string | No | Filter text messages sent from a specific sender's phone number. |
| `groupTextId` | integer | No | Filter by group text ID. |
| `participants` | string | No | Filter by participants. |
| `sharedInboxId` | integer | No | Filter by shared inbox ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Text Message Templates

**Slug:** `FOLLOW_UP_BOSS_LIST_TEXT_MESSAGE_TEMPLATES`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Number of results to return. Max 100. |
| `offset` | integer | No | Specifies the number of rows to skip before starting to return results. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Timeframes

**Slug:** `FOLLOW_UP_BOSS_LIST_TIMEFRAMES`

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Users

**Slug:** `FOLLOW_UP_BOSS_LIST_USERS`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Find a user by their full name. Exact matches only, no partial matching available. |
| `role` | string | No | Find users by a specific role (e.g., 'Broker', 'Agent', 'Lender'). |
| `sort` | string | No | Field to sort by. Currently only 'id', 'name' and 'created' are available. |
| `email` | string | No | Find a user by their email address. |
| `limit` | integer | No | Number of results to return. Max 100. |
| `fields` | string | No | 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). |
| `offset` | integer | No | Specifies the number of rows to skip before starting to return results. |
| `includeDeleted` | boolean | No | Setting this to true will include users that have been deleted. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Webhooks

**Slug:** `FOLLOW_UP_BOSS_LIST_WEBHOOKS`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sort` | string ("id" | "created" | "updated" | "status" | "event") | No | Sort order options for webhooks. |
| `event` | string | No | Search for webhooks by event (e.g., 'peopleCreated' or 'peopleUpdated'). |
| `limit` | integer | No | Number of results to return. Max 100. |
| `offset` | integer | No | Specifies the number of rows to skip before starting to return results. |
| `status` | string ("Active" | "Disabled") | No | Status values for filtering webhooks. |
| `X-System` | string | No | The name of the registered system. |
| `X-System-Key` | string | No | The key of the registered system. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Merge Template

**Slug:** `FOLLOW_UP_BOSS_MERGE_TEMPLATE`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `recipients` | object | No | Model for recipients object containing To/CC/BCC/From fields. |
| `templateId` | integer | Yes | The ID of the email template to merge. |
| `mergePersonId` | integer | No | Person ID to use for merge fields like %contact_name%. If not provided, the first recipient matching a person will be used. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Merge Text Message Template

**Slug:** `FOLLOW_UP_BOSS_MERGE_TEXT_MESSAGE_TEMPLATE`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `personId` | integer | No | Person ID to use for merge fields like %contact_name%. If not provided, the first recipient will be used |
| `recipients` | object | No | Container for message recipients |
| `templateId` | integer | Yes | The ID of the text message template to merge |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Action Plan People Status

**Slug:** `FOLLOW_UP_BOSS_UPDATE_ACTION_PLANS_PEOPLE`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | The ID of the Action Plan People object to update. |
| `status` | string ("Running" | "Paused") | Yes | The desired state of the applied action plan. Either 'Running' or 'Paused'. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Appointment

**Slug:** `FOLLOW_UP_BOSS_UPDATE_APPOINTMENT`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | The id of the appointment to update. |
| `end` | string | Yes | 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'). |
| `start` | string | Yes | 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'). |
| `title` | string | Yes | Title of the appointment. |
| `allDay` | boolean | No | Sets whether the appointment is an all day event or not. |
| `typeId` | integer | No | The Follow Up Boss appointment type identifier. |
| `invitees` | array | No | 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. |
| `location` | string | No | The location or address of the appointment. |
| `outcomeId` | integer | No | The Follow Up Boss appointment outcome identifier. |
| `description` | string | No | Description of the appointment or event. |
| `sendInvitation` | boolean | No | Send an invitation email to invitees. If the 'appointment reminders' feature is enabled, an SMS reminder will also be sent. Defaults to false. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update appointment outcome

**Slug:** `FOLLOW_UP_BOSS_UPDATE_APPOINTMENT_OUTCOMES`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | The id of the appointment outcome to update. |
| `name` | string | No | The name of the appointment outcome. |
| `orderWeight` | integer | No | Set this value to enforce a specific sort order. Higher values appear later in the list. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Appointment Type

**Slug:** `FOLLOW_UP_BOSS_UPDATE_APPOINTMENT_TYPES`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | The id of the appointment type to update. |
| `name` | string | No | The name of the appointment type. |
| `orderWeight` | integer | No | Set this value to enforce a specific sort order. Higher values appear later in the list. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Call

**Slug:** `FOLLOW_UP_BOSS_UPDATE_CALLS`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | The ID of the call to update. |
| `note` | string | No | The log message entered for this call. |
| `phone` | string | No | The phone number this call was made to or from. |
| `userId` | integer | No | 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. |
| `outcome` | string ("Interested" | "Not Interested" | "Left Message" | "No Answer" | "Busy" | "Bad Number") | No | Possible outcomes for a call. |
| `duration` | integer | No | Length of the call in seconds. |
| `personId` | integer | No | The ID of a person associated with this call. |
| `toNumber` | string | No | The phone number this call was made to. |
| `fromNumber` | string | No | The phone number this call was made from. |
| `isIncoming` | boolean | No | Sets this as an incoming or outgoing call. |
| `recordingUrl` | string | No | The URL for the call recording. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Custom Fields

**Slug:** `FOLLOW_UP_BOSS_UPDATE_CUSTOM_FIELDS`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | The ID of the custom field to update. Must be a valid custom field ID. |
| `label` | string | No | The user-friendly name of the custom field (e.g., "Anniversary", "Customer Type"). This is the label that will be displayed in the UI. |
| `choices` | array | No | Array of options related to a custom field of type 'dropdown'. Each string represents one selectable option. Only applicable for dropdown type fields. |
| `hideIfEmpty` | boolean | No | 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. |
| `isRecurring` | boolean | No | Sets whether a date field occurs every year (e.g., birthdays, anniversaries, etc.). Only applicable for 'date' type custom fields. Defaults to false. |
| `orderWeight` | integer | No | A weighted integer for the field to assign values for custom sorting. Higher values appear later in the list. Defaults to 0. |
| `dropdownChoiceMap` | array | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Deal Custom Fields

**Slug:** `FOLLOW_UP_BOSS_UPDATE_DEAL_CUSTOM_FIELDS`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | The id of the deals custom field to update. |
| `type` | string ("text" | "date" | "number" | "dropdown") | Yes | The type of deal custom field. |
| `label` | string | Yes | The user-friendly name of the custom field (e.g., 'Anniversary', 'Deal Stage'). |
| `choices` | array | No | Array of options related to a deals custom field of type 'dropdown'. Required when type is 'dropdown', ignored otherwise. |
| `readOnly` | boolean | No | Determines whether the deal custom field is read-only. Defaults to false. |
| `hideIfEmpty` | boolean | No | Sets whether to hide this field if it is empty. Defaults to false. |
| `isRecurring` | boolean | No | Whether a date field occurs every year (e.g. birthdays, anniversaries). Only applicable when type is 'date'. Defaults to false. |
| `orderWeight` | integer | No | A weighted integer for custom sorting of fields. Higher weights appear later. Defaults to 0. |
| `dropdownChoiceMap` | array | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Deal

**Slug:** `FOLLOW_UP_BOSS_UPDATE_DEALS`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | The id of the deal to update. This is a required field. |
| `name` | string | No | Name of the deal. |
| `price` | integer | No | The price associated with this deal. |
| `stageId` | integer | No | The stage that this deal should be assigned to. |
| `userIds` | array | No | A list of user ids that should be part of this deal. |
| `peopleIds` | array | No | A list of person ids that should be part of this deal. |
| `description` | string | No | Description of the deal. |
| `possessionDate` | string | No | Possession Date for this deal in date format (YYYY-MM-DD). |
| `teamCommission` | integer | No | Commission value for a team split. |
| `agentCommission` | integer | No | Commission value for an agent split. |
| `commissionValue` | integer | No | Commission value to assign to this deal. |
| `dueDiligenceDate` | string | No | Due Diligence Date for this deal in date format (YYYY-MM-DD). |
| `projectedCloseDate` | string | No | Projected close date of this deal in date format (YYYY-MM-DD). |
| `earnestMoneyDueDate` | string | No | Earnest Money Due Date for this deal in date format (YYYY-MM-DD). |
| `finalWalkThroughDate` | string | No | Final Walk Through Date for this deal in date format (YYYY-MM-DD). |
| `mutualAcceptanceDate` | string | No | Mutual Acceptance Date for this deal in date format (YYYY-MM-DD). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Email Marketing Campaign

**Slug:** `FOLLOW_UP_BOSS_UPDATE_EM_CAMPAIGNS`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | Follow Up Boss ID of the email campaign to update. |
| `name` | string | No | Name of the email campaign or template. |
| `subject` | string | No | Email subject line. |
| `bodyHtml` | string | No | Email body in HTML format. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Group

**Slug:** `FOLLOW_UP_BOSS_UPDATE_GROUPS`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | The id of the group to update. |
| `name` | string | Yes | The name of the group. |
| `type` | string ("Agent" | "Lender") | No | Type of group defining which user roles can be members. |
| `users` | array | Yes | An array of user IDs that will be members of this group. |
| `claimWindow` | integer | No | 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). |
| `distribution` | string ("first-to-claim" | "round-robin") | No | Distribution model for group lead assignment. |
| `defaultPondId` | integer | No | The ID of the pond to assign unclaimed first-to-claim leads to after the claim window expires. |
| `defaultUserId` | integer | No | The ID of the user to assign unclaimed first-to-claim leads to after the claim window expires. |
| `defaultGroupId` | integer | No | The ID of the group to assign unclaimed first-to-claim leads to after the claim window expires. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update People Relationships

**Slug:** `FOLLOW_UP_BOSS_UPDATE_PEOPLE_RELATIONSHIPS`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | The ID of a given relationship. |
| `type` | string | No | The type of relationship (e.g., Spouse, Brother, Partner, etc.). |
| `emails` | array | No | 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. |
| `phones` | array | No | 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. |
| `lastName` | string | No | The last/family name of the relationship. |
| `addresses` | array | No | 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. |
| `firstName` | string | No | The first/given name of the relationship. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Pipeline

**Slug:** `FOLLOW_UP_BOSS_UPDATE_PIPELINES`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | The id of the pipeline to update. |
| `name` | string | No | The name of the pipeline. |
| `stages` | array | No | An array of stage objects that should be associated with the pipeline. Each stage must have a name and closedStage indicator. |
| `description` | string | No | Description of the pipeline. |
| `orderWeight` | integer | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Ponds

**Slug:** `FOLLOW_UP_BOSS_UPDATE_PONDS`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | The pond id. |
| `name` | string | No | Set this value to change the name of the Pond |
| `userId` | integer | No | Set this value to change the Pond Lead Agent |
| `userIds` | array | No | Set this value to add or remove members from the pond |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Stage

**Slug:** `FOLLOW_UP_BOSS_UPDATE_STAGES`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | The id of the stage to update. |
| `name` | string | No | Name of the stage. |
| `orderWeight` | integer | No | Helps to set a specific sort order. Higher values appear later in the list. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Team

**Slug:** `FOLLOW_UP_BOSS_UPDATE_TEAMS`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | The team id to update. |
| `name` | string | No | The team name. |
| `userIds` | array | No | The complete list of members of this team. If provided, this replaces all existing members. |
| `leaderIds` | array | No | The complete list of team leaders. If provided, this replaces all existing leaders. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update email template

**Slug:** `FOLLOW_UP_BOSS_UPDATE_TEMPLATES`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The ID of the email template to update. |
| `body` | string | Yes | The new body for the email template. May include merge fields like {{firstName}} or %contact_first_name%. |
| `name` | string | Yes | The new name for the email template. |
| `subject` | string | Yes | The new subject for the email template. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Text Message Template

**Slug:** `FOLLOW_UP_BOSS_UPDATE_TEXT_MESSAGE_TEMPLATE`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The ID of the text message template to update. |
| `name` | string | Yes | The name of your text message template. |
| `message` | string | Yes | The body of your text message template. Can include variables like %greeting_time%, %contact_first_name%, %agent_first_name%, %company_name%. |
| `isShared` | boolean | No | Set to true if this template should be shared with other users in the same Follow Up Boss account. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |