Search for events. (GET /events) Defaults to limit=100 (FUB's max per page) rather than its own default of 10 — bulk requests are the common case here. If the response's _metadata shows more results remain, keep paginating: use offset for offset-based endpoints, or the _metadata.next cursor value (as the next argument) for cursor-based endpoints like notes.

Send in a lead or an event related to a lead. (POST /events) Use this — not create_person — when a NEW LEAD needs to be registered and should trigger FUB's lead routing, automations, and per-source workflows. create_person only inserts a bare contact record and triggers none of that; this is the actual lead-ingestion event. Set type to one of Registration, Inquiry, Seller Inquiry, Property Inquiry, General Inquiry, Viewed Property, Saved Property, Visited Website, Incoming Call, Unsubscribed, Property Search, Saved Property Search, Visited Open House, or Viewed Page — Registration for a genuinely new lead. Set source (and system if relevant) since lead routing rules commonly key off source. FUB auto-deduplicates the nested person object by phone/email — no separate deduplicate flag needed here, unlike create_person. ⚠️ If occurredAt is set to more than 1 day in the past, FUB treats the event as historical and will NOT trigger routing/automations at all — leave it unset (defaults to now) or within the last day if the point is to actually trigger workflows; only backdate it deliberately for importing historical data where you specifically don't want anything to fire.

Retrieve a single event by id. (GET /events/{id})

Search for people. (GET /people) Defaults to limit=100 (FUB's max per page) rather than its own default of 10 — bulk requests are the common case here. If the response's _metadata shows more results remain, keep paginating: use offset for offset-based endpoints, or the _metadata.next cursor value (as the next argument) for cursor-based endpoints like notes. Use fields to request only what you need instead of full records when scanning many people. For custom fields, call list_custom_fields first to discover the exact field names/labels rather than guessing. FUB's docs also list a wildcard "custom*" field here for reading/writing custom fields directly (e.g. a "Closing Date" field as custom.ClosingDate) — that's not a literal field name, so it's not in this tool's fixed schema. Pass custom. entries via extraQuery instead. Call list_custom_fields first to get exact names.

Manually add a new person. (POST /people) FUB's docs also list a wildcard "custom*" field here for reading/writing custom fields directly (e.g. a "Closing Date" field as custom.ClosingDate) — that's not a literal field name, so it's not in this tool's fixed schema. Pass custom. entries via extraBody instead. Call list_custom_fields first to get exact names. deduplicate defaults to false, meaning creating a person whose email or phone matches an existing contact creates a SEPARATE duplicate record rather than erring or merging — a common way CRMs end up full of duplicate leads. Unless the user clearly wants an intentional second/separate record (e.g. a shared household phone), pass deduplicate=true, or call get_people_check_duplicate first and confirm with the user if a likely match already exists. ⚠️ This does NOT register a new lead in FUB's sense: it creates a bare contact record only — no lead routing, no automations, no per-source workflows fire. If the user actually means "a new lead just came in" (e.g. from a website registration, an inquiry, an open house sign-in) rather than "just add this person to my CRM," use create_event instead — that's what actually triggers FUB's lead routing and automations.

Retrieve a person by id. (GET /people/{id}) Use fields to request only what you need instead of full records when scanning many people. For custom fields, call list_custom_fields first to discover the exact field names/labels rather than guessing.

Update a person by id. (PUT /people/{id}) FUB's docs also list a wildcard "custom*" field here for reading/writing custom fields directly (e.g. a "Closing Date" field as custom.ClosingDate) — that's not a literal field name, so it's not in this tool's fixed schema. Pass custom. entries via extraBody instead. Call list_custom_fields first to get exact names. Tag removal has no dedicated endpoint: to remove a tag, first GET this person, filter the tag out of their current tags array yourself, then PUT the full filtered array back (with mergeTags left at its default of false so it replaces rather than merges). To add tags, just pass the new tags with mergeTags=true (this tool's default) so they're unioned with the person's existing tags. ⚠️ DATA LOSS RISK, confirmed against the live API: emails, phones, and addresses are REPLACED wholesale if you include them — there is no merge flag for these like there is for tags. Sending a single new phone number wipes out every other phone number the person had. To add one without losing the rest, GET the person first, append to their existing emails/phones/addresses array yourself, and PUT the complete merged array back. Never send a partial list unless the user explicitly wants everything else removed. collaborators is also settable here even though FUB's own docs don't list it on this endpoint (confirmed working in practice) — it has the same replace-not-merge behavior as tags/phones: omitting an existing collaborator's user id removes them, so GET the person first and merge if you only want to add one. Pass it via extraBody. Setting stage to "Trash" hides the person from default list views (FUB excludes trashed people from GET /people unless includeTrash is set) — it's reversible, but feels like the contact vanished to someone who isn't expecting it, so this requires confirm=true just like a delete, even though it isn't one.

Search for users. (GET /users) Defaults to limit=100 (FUB's max per page) rather than its own default of 10 — bulk requests are the common case here. If the response's _metadata shows more results remain, keep paginating: use offset for offset-based endpoints, or the _metadata.next cursor value (as the next argument) for cursor-based endpoints like notes. Use fields to request only what you need instead of full records when scanning many people. For custom fields, call list_custom_fields first to discover the exact field names/labels rather than guessing.

Get a list of Smart Lists. (GET /smartLists) Defaults to limit=100 (FUB's max per page) rather than its own default of 10 — bulk requests are the common case here. If the response's _metadata shows more results remain, keep paginating: use offset for offset-based endpoints, or the _metadata.next cursor value (as the next argument) for cursor-based endpoints like notes.

Retrieve a Smart List by id. (GET /smartLists/{id})

Retrieve an email template by id, optionally merging fields. (GET /templates/{id})

Update an email template. (PUT /templates/{id}) FUB templates support %merge_field% placeholders that FUB substitutes when a human actually sends the template (not by this tool — this just saves the template text as-is). Reference: Contact: %contact_name% (full), %contact_first_name%, %contact_last_name%, %contact_email%, %contact_phone%, %contact_address%, %contact_street%, %contact_city%, %contact_state%, %contact_zipcode%, %contact_country%, %contact_rels_first_name% (first names of the contact's linked relationships, e.g. spouse/family added via peopleRelationships). Company (from Admin > Company settings): %company_name%, %company_phone%. Agent / Lender / Sender — same field set, swap the prefix (agent = assigned agent, lender = assigned lender, sender = whoever is actually sending this particular message, which may be neither): %agent_name%, %agent_first_name%, %agent_last_name%, %agent_email%, %agent_phone% (the FUB-assigned calling/texting number), %agent_mobile_phone% (their real/personal number), %agent_merge_field_1% (one free-form field each user sets in My Settings > Other Settings > Edit User Merge Field — commonly a booking link or social profile). ⚠️ %_phone% vs %mobile_phone% is genuinely ambiguous — always confirm with the user which one they mean before using either; picking wrong sends the recipient the wrong callback number. Inquiry (how the contact became a lead, e.g. clicking "Get more info" on a listing site): %inquiry_address%, %inquiry_address_url% (only if the lead source provided one), %inquiry_address_preview% (renders an HTML photo+link box — email only, meaningless in a plain-text SMS template). Recently viewed (populated only when synced with a provider that shares property views): %viewed_address%, %viewed_address_url%, %viewed_address_preview%, %last_5_preview% (up to 5 as HTML boxes, email only). Other: %source_name% (lead source, e.g. "Zillow" — "I saw your inquiry on %source_name%"), %greeting_time% ("Morning"/"Afternoon"/"Evening" based on send time — "Good %greeting_time%, %contact_first_name%"), %tour_time% (populated if the contact scheduled a tour via Zillow). Custom fields: %custom% (e.g. %custom_website%, %custom_birthday%, %custom_spouse_name%). Call list_custom_fields to confirm a field exists — but note its API name (e.g. customBirthday, camelCase) and its merge-field name (%custom_birthday%, snake_case) are different spellings of the same field, and there's no API that returns the merge-field spelling directly, so confirm the exact form with the user (or FUB's own Merge Fields dropdown in the template composer) if it's not obvious from the label. A merge field with no value for a given contact is simply left blank when the template is used — not an error, not a visible placeholder.

List all custom fields. (GET /customFields) Defaults to limit=100 (FUB's max per page) rather than its own default of 10 — bulk requests are the common case here. If the response's _metadata shows more results remain, keep paginating: use offset for offset-based endpoints, or the _metadata.next cursor value (as the next argument) for cursor-based endpoints like notes.

Create a custom field. (POST /customFields)

Add a note. (POST /notes) If body contains HTML markup, you must also pass isHtml=true — unlike email templates, FUB does not auto-detect HTML in notes.

Retrieve a user by id. (GET /users/{id})

Lists all email templates. (GET /templates) Defaults to limit=100 (FUB's max per page) rather than its own default of 10 — bulk requests are the common case here. If the response's _metadata shows more results remain, keep paginating: use offset for offset-based endpoints, or the _metadata.next cursor value (as the next argument) for cursor-based endpoints like notes.

Create a new email template. (POST /templates) body is the raw HTML of the email template directly — there is no separate isHtml/html flag for templates (unlike notes, which need isHtml=true explicitly). FUB templates support %merge_field% placeholders that FUB substitutes when a human actually sends the template (not by this tool — this just saves the template text as-is). Reference: Contact: %contact_name% (full), %contact_first_name%, %contact_last_name%, %contact_email%, %contact_phone%, %contact_address%, %contact_street%, %contact_city%, %contact_state%, %contact_zipcode%, %contact_country%, %contact_rels_first_name% (first names of the contact's linked relationships, e.g. spouse/family added via peopleRelationships). Company (from Admin > Company settings): %company_name%, %company_phone%. Agent / Lender / Sender — same field set, swap the prefix (agent = assigned agent, lender = assigned lender, sender = whoever is actually sending this particular message, which may be neither): %agent_name%, %agent_first_name%, %agent_last_name%, %agent_email%, %agent_phone% (the FUB-assigned calling/texting number), %agent_mobile_phone% (their real/personal number), %agent_merge_field_1% (one free-form field each user sets in My Settings > Other Settings > Edit User Merge Field — commonly a booking link or social profile). ⚠️ %_phone% vs %mobile_phone% is genuinely ambiguous — always confirm with the user which one they mean before using either; picking wrong sends the recipient the wrong callback number. Inquiry (how the contact became a lead, e.g. clicking "Get more info" on a listing site): %inquiry_address%, %inquiry_address_url% (only if the lead source provided one), %inquiry_address_preview% (renders an HTML photo+link box — email only, meaningless in a plain-text SMS template). Recently viewed (populated only when synced with a provider that shares property views): %viewed_address%, %viewed_address_url%, %viewed_address_preview%, %last_5_preview% (up to 5 as HTML boxes, email only). Other: %source_name% (lead source, e.g. "Zillow" — "I saw your inquiry on %source_name%"), %greeting_time% ("Morning"/"Afternoon"/"Evening" based on send time — "Good %greeting_time%, %contact_first_name%"), %tour_time% (populated if the contact scheduled a tour via Zillow). Custom fields: %custom% (e.g. %custom_website%, %custom_birthday%, %custom_spouse_name%). Call list_custom_fields to confirm a field exists — but note its API name (e.g. customBirthday, camelCase) and its merge-field name (%custom_birthday%, snake_case) are different spellings of the same field, and there's no API that returns the merge-field spelling directly, so confirm the exact form with the user (or FUB's own Merge Fields dropdown in the template composer) if it's not obvious from the label. A merge field with no value for a given contact is simply left blank when the template is used — not an error, not a visible placeholder.

Get a list of Action Plans. (GET /actionPlans) Defaults to limit=100 (FUB's max per page) rather than its own default of 10 — bulk requests are the common case here. If the response's _metadata shows more results remain, keep paginating: use offset for offset-based endpoints, or the _metadata.next cursor value (as the next argument) for cursor-based endpoints like notes. ⚠️ Action Plans are a deprecated FUB feature — Automations are the current, recommended mechanism going forward. Unless the user specifically names an existing legacy Action Plan they already rely on, prefer the automationsPerson tools (create_automations_person to trigger one, update_automations_person to pause/unpause) over this one for new workflows.

Retrieve a note by id. (GET /notes/{id})

Edit a note. (PUT /notes/{id}) If body contains HTML markup, you must also pass isHtml=true.

Get a custom field by id. (GET /customFields/{id})

Update a custom field. (PUT /customFields/{id})

Retrieve information about the currently authenticated user. (GET /me)

Search for calls. (GET /calls) Defaults to limit=100 (FUB's max per page) rather than its own default of 10 — bulk requests are the common case here. If the response's _metadata shows more results remain, keep paginating: use offset for offset-based endpoints, or the _metadata.next cursor value (as the next argument) for cursor-based endpoints like notes.

Add a call. (POST /calls)

Update the status of an Action Plan to Person relationship. (PUT /actionPlansPeople/{id}) ⚠️ Action Plans are a deprecated FUB feature — Automations are the current, recommended mechanism going forward. Unless the user specifically names an existing legacy Action Plan they already rely on, prefer the automationsPerson tools (create_automations_person to trigger one, update_automations_person to pause/unpause) over this one for new workflows.

Retrieve a call by id. (GET /calls/{id})

Update a call. (PUT /calls/{id})

List Action Plans applied to a particular person or list people on a particular Action Plan. (GET /actionPlansPeople) Defaults to limit=100 (FUB's max per page) rather than its own default of 10 — bulk requests are the common case here. If the response's _metadata shows more results remain, keep paginating: use offset for offset-based endpoints, or the _metadata.next cursor value (as the next argument) for cursor-based endpoints like notes. ⚠️ Action Plans are a deprecated FUB feature — Automations are the current, recommended mechanism going forward. Unless the user specifically names an existing legacy Action Plan they already rely on, prefer the automationsPerson tools (create_automations_person to trigger one, update_automations_person to pause/unpause) over this one for new workflows.

Apply an Action Plan to a person. (POST /actionPlansPeople) ⚠️ Action Plans are a deprecated FUB feature — Automations are the current, recommended mechanism going forward. Unless the user specifically names an existing legacy Action Plan they already rely on, prefer the automationsPerson tools (create_automations_person to trigger one, update_automations_person to pause/unpause) over this one for new workflows.

List email marketing events. (GET /emEvents) Defaults to limit=100 (FUB's max per page) rather than its own default of 10 — bulk requests are the common case here. If the response's _metadata shows more results remain, keep paginating: use offset for offset-based endpoints, or the _metadata.next cursor value (as the next argument) for cursor-based endpoints like notes.

Notify Follow Up Boss about marketing emails sent, opens, clicks, bounces, unsubscribes and spam reports. (POST /emEvents)

Retrieve a list of stages. (GET /stages) Defaults to limit=100 (FUB's max per page) rather than its own default of 10 — bulk requests are the common case here. If the response's _metadata shows more results remain, keep paginating: use offset for offset-based endpoints, or the _metadata.next cursor value (as the next argument) for cursor-based endpoints like notes.

Create a new stage. (POST /stages)

Get a stage by id. (GET /stages/{id})

Update a stage. (PUT /stages/{id})

Get details of a specific webhook. (GET /webhooks/{id})

Update a webhook. (PUT /webhooks/{id})

Get a list of webhooks. (GET /webhooks) Defaults to limit=100 (FUB's max per page) rather than its own default of 10 — bulk requests are the common case here. If the response's _metadata shows more results remain, keep paginating: use offset for offset-based endpoints, or the _metadata.next cursor value (as the next argument) for cursor-based endpoints like notes.

Subscribe to a new webhook. (POST /webhooks)

Get a list of events for a given webhook. (GET /webhookEvents/{id})

Get a list of tasks. (GET /tasks)

Create a new task. (POST /tasks)

Get a task by id. (GET /tasks/{id})

Update a task. (PUT /tasks/{id})

List email marketing campaigns. (GET /emCampaigns)

Create an email marketing campaign. (POST /emCampaigns)

Update an email marketing campaign. (PUT /emCampaigns/{id})

Retrieve a deal by id. (GET /deals/{id})

Update a deal. (PUT /deals/{id})

Retrieve a pipeline by id. (GET /pipelines/{id})

Update a pipeline. (PUT /pipelines/{id})

Search for deals. (GET /deals)

Add a deal. (POST /deals)

Search for pipelines. (GET /pipelines)

Add a pipeline. (POST /pipelines)

Get identity and authentication information. (GET /identity)

List text messages for a person or phone number. (GET /textMessages)

Create a record of an externally sent text message. (POST /textMessages)

Retrieve a text message by id. (GET /textMessages/{id})

Search for appointments. (GET /appointments) Defaults to limit=100 (FUB's max per page) rather than its own default of 10 — bulk requests are the common case here. If the response's _metadata shows more results remain, keep paginating: use offset for offset-based endpoints, or the _metadata.next cursor value (as the next argument) for cursor-based endpoints like notes.

Create an appointment. (POST /appointments)

Retrieve an appointment by id. (GET /appointments/{id})

Update an appointment. (PUT /appointments/{id})

Get relationships between people in Follow Up Boss. (GET /peopleRelationships)

Create a new relationship for a person. (POST /peopleRelationships)

Get a specific relationship. (GET /peopleRelationships/{id})

Update details of a specific relationship. (PUT /peopleRelationships/{id})

Merge an email template with multiple recipients. (POST /templates/merge) Despite the name, this almost certainly does NOT send anything — inferred from its identical-shaped sibling post_text_message_templates_merge, which was verified live 2026-09 (firing it at a real phone number produced no delivery and no new record in list_text_messages, only a rendered string back); the email variant itself wasn't separately fired to avoid sending an unwanted email. It's a preview/render utility for the edge case of one message greeting multiple recipients at once (e.g. "Hey Bob, Alice and Carol...") — useful for composing that combined greeting, not for actually delivering it.

Merge a text message template with multiple recipients. (POST /textMessageTemplates/merge) Despite the name, this does NOT send anything — verified live 2026-09: firing this at a real phone number produced no delivery and no new record in list_text_messages, only a rendered string back ({"mergedTemplate": "..."}). It's a preview/render utility for the edge case of one text greeting multiple recipients at once (e.g. "Hey Bob, Alice and Carol..."), not an actual send.

Check whether a person exists in Follow Up Boss. (GET /people/checkDuplicate)

Get unclaimed leads. (GET /people/unclaimed) Defaults to limit=100 (FUB's max per page) rather than its own default of 10 — bulk requests are the common case here. If the response's _metadata shows more results remain, keep paginating: use offset for offset-based endpoints, or the _metadata.next cursor value (as the next argument) for cursor-based endpoints like notes.

Claim a lead. (POST /people/claim)

Ignore a lead. (POST /people/ignoreUnclaimed)

Lists all text message templates. (GET /textMessageTemplates) Defaults to limit=100 (FUB's max per page) rather than its own default of 10 — bulk requests are the common case here. If the response's _metadata shows more results remain, keep paginating: use offset for offset-based endpoints, or the _metadata.next cursor value (as the next argument) for cursor-based endpoints like notes.

Retrieve a text message template by id. (GET /textMessageTemplates/{id})

Update a text message template. (PUT /textMessageTemplates/{id}) FUB templates support %merge_field% placeholders that FUB substitutes when a human actually sends the template (not by this tool — this just saves the template text as-is). Reference: Contact: %contact_name% (full), %contact_first_name%, %contact_last_name%, %contact_email%, %contact_phone%, %contact_address%, %contact_street%, %contact_city%, %contact_state%, %contact_zipcode%, %contact_country%, %contact_rels_first_name% (first names of the contact's linked relationships, e.g. spouse/family added via peopleRelationships). Company (from Admin > Company settings): %company_name%, %company_phone%. Agent / Lender / Sender — same field set, swap the prefix (agent = assigned agent, lender = assigned lender, sender = whoever is actually sending this particular message, which may be neither): %agent_name%, %agent_first_name%, %agent_last_name%, %agent_email%, %agent_phone% (the FUB-assigned calling/texting number), %agent_mobile_phone% (their real/personal number), %agent_merge_field_1% (one free-form field each user sets in My Settings > Other Settings > Edit User Merge Field — commonly a booking link or social profile). ⚠️ %_phone% vs %mobile_phone% is genuinely ambiguous — always confirm with the user which one they mean before using either; picking wrong sends the recipient the wrong callback number. Inquiry (how the contact became a lead, e.g. clicking "Get more info" on a listing site): %inquiry_address%, %inquiry_address_url% (only if the lead source provided one), %inquiry_address_preview% (renders an HTML photo+link box — email only, meaningless in a plain-text SMS template). Recently viewed (populated only when synced with a provider that shares property views): %viewed_address%, %viewed_address_url%, %viewed_address_preview%, %last_5_preview% (up to 5 as HTML boxes, email only). Other: %source_name% (lead source, e.g. "Zillow" — "I saw your inquiry on %source_name%"), %greeting_time% ("Morning"/"Afternoon"/"Evening" based on send time — "Good %greeting_time%, %contact_first_name%"), %tour_time% (populated if the contact scheduled a tour via Zillow). Custom fields: %custom% (e.g. %custom_website%, %custom_birthday%, %custom_spouse_name%). Call list_custom_fields to confirm a field exists — but note its API name (e.g. customBirthday, camelCase) and its merge-field name (%custom_birthday%, snake_case) are different spellings of the same field, and there's no API that returns the merge-field spelling directly, so confirm the exact form with the user (or FUB's own Merge Fields dropdown in the template composer) if it's not obvious from the label. A merge field with no value for a given contact is simply left blank when the template is used — not an error, not a visible placeholder. Texting-specific, per FUB's own Compliance/Carrier Filtering guidance: initial/first-outreach text templates should include opt-out language ("Reply STOP to unsubscribe") and introduce the sender/company by name. Avoid designing a template purely for identical mass-blasting — carriers filter messages that look like spam, personalization (via merge fields) reduces that risk. If the template includes a URL, use the full URL rather than a shortened link, since shorteners are more likely to get carrier-filtered.

List groups. (GET /groups)

Create a new group. (POST /groups)

Lists groups and includes round-robin data. (GET /groups/roundRobin)

Retrieve a group by id. (GET /groups/{id})

Update a group. (PUT /groups/{id})

Get a list of teams. (GET /teams) Defaults to limit=100 (FUB's max per page) rather than its own default of 10 — bulk requests are the common case here. If the response's _metadata shows more results remain, keep paginating: use offset for offset-based endpoints, or the _metadata.next cursor value (as the next argument) for cursor-based endpoints like notes.

Create a new team. (POST /teams)

Get a team by id. (GET /teams/{id})

Update a team by id. (PUT /teams/{id})

Get a list of ponds. (GET /ponds) Defaults to limit=100 (FUB's max per page) rather than its own default of 10 — bulk requests are the common case here. If the response's _metadata shows more results remain, keep paginating: use offset for offset-based endpoints, or the _metadata.next cursor value (as the next argument) for cursor-based endpoints like notes.

Create a pond. (POST /ponds)

Get a pond by id. (GET /ponds/{id})

Update a pond by id. (PUT /ponds/{id})

Create a text message template. (POST //textMessageTemplates) FUB templates support %merge_field% placeholders that FUB substitutes when a human actually sends the template (not by this tool — this just saves the template text as-is). Reference: Contact: %contact_name% (full), %contact_first_name%, %contact_last_name%, %contact_email%, %contact_phone%, %contact_address%, %contact_street%, %contact_city%, %contact_state%, %contact_zipcode%, %contact_country%, %contact_rels_first_name% (first names of the contact's linked relationships, e.g. spouse/family added via peopleRelationships). Company (from Admin > Company settings): %company_name%, %company_phone%. Agent / Lender / Sender — same field set, swap the prefix (agent = assigned agent, lender = assigned lender, sender = whoever is actually sending this particular message, which may be neither): %agent_name%, %agent_first_name%, %agent_last_name%, %agent_email%, %agent_phone% (the FUB-assigned calling/texting number), %agent_mobile_phone% (their real/personal number), %agent_merge_field_1% (one free-form field each user sets in My Settings > Other Settings > Edit User Merge Field — commonly a booking link or social profile). ⚠️ %_phone% vs %mobile_phone% is genuinely ambiguous — always confirm with the user which one they mean before using either; picking wrong sends the recipient the wrong callback number. Inquiry (how the contact became a lead, e.g. clicking "Get more info" on a listing site): %inquiry_address%, %inquiry_address_url% (only if the lead source provided one), %inquiry_address_preview% (renders an HTML photo+link box — email only, meaningless in a plain-text SMS template). Recently viewed (populated only when synced with a provider that shares property views): %viewed_address%, %viewed_address_url%, %viewed_address_preview%, %last_5_preview% (up to 5 as HTML boxes, email only). Other: %source_name% (lead source, e.g. "Zillow" — "I saw your inquiry on %source_name%"), %greeting_time% ("Morning"/"Afternoon"/"Evening" based on send time — "Good %greeting_time%, %contact_first_name%"), %tour_time% (populated if the contact scheduled a tour via Zillow). Custom fields: %custom% (e.g. %custom_website%, %custom_birthday%, %custom_spouse_name%). Call list_custom_fields to confirm a field exists — but note its API name (e.g. customBirthday, camelCase) and its merge-field name (%custom_birthday%, snake_case) are different spellings of the same field, and there's no API that returns the merge-field spelling directly, so confirm the exact form with the user (or FUB's own Merge Fields dropdown in the template composer) if it's not obvious from the label. A merge field with no value for a given contact is simply left blank when the template is used — not an error, not a visible placeholder. Texting-specific, per FUB's own Compliance/Carrier Filtering guidance: initial/first-outreach text templates should include opt-out language ("Reply STOP to unsubscribe") and introduce the sender/company by name. Avoid designing a template purely for identical mass-blasting — carriers filter messages that look like spam, personalization (via merge fields) reduces that risk. If the template includes a URL, use the full URL rather than a shortened link, since shorteners are more likely to get carrier-filtered.

List all deals custom fields available in your account. (GET /dealCustomFields) Defaults to limit=100 (FUB's max per page) rather than its own default of 10 — bulk requests are the common case here. If the response's _metadata shows more results remain, keep paginating: use offset for offset-based endpoints, or the _metadata.next cursor value (as the next argument) for cursor-based endpoints like notes.

Create a deals custom field. (POST /dealCustomFields)

Get a deals custom field by ID. (GET /dealCustomFields/{id})

Update a deals custom field. (PUT /dealCustomFields/{id})

List appointment types. (GET /appointmentTypes) Defaults to limit=100 (FUB's max per page) rather than its own default of 10 — bulk requests are the common case here. If the response's _metadata shows more results remain, keep paginating: use offset for offset-based endpoints, or the _metadata.next cursor value (as the next argument) for cursor-based endpoints like notes.

Create an appointment type. (POST /appointmentTypes)

Retrieve an appointment type by ID (GET /appointmentTypes/{id})

Update an appointment type. (PUT /appointmentTypes/{id})

List appointment outcomes. (GET /appointmentOutcomes) Defaults to limit=100 (FUB's max per page) rather than its own default of 10 — bulk requests are the common case here. If the response's _metadata shows more results remain, keep paginating: use offset for offset-based endpoints, or the _metadata.next cursor value (as the next argument) for cursor-based endpoints like notes.

Create an appointment outcome. (POST /appointmentOutcomes)

Retrieve an appointment outcome by ID. (GET /appointmentOutcomes/{id})

Update an appointment outcome. (PUT /appointmentOutcomes/{id})

Attach a file to a person. (POST /personAttachments)

Add an attachment to a deal. (POST /dealAttachments)

Retrieve an attachment by ID. (GET /personAttachments/{id})

Update an attachment by ID. (PUT /personAttachments/{id})

Get a deal attachment by id. (GET /dealAttachments/{id})

Update a deal attachment. (PUT /dealAttachments/{id})

Get a list of pairings of Automations and the People on which they have or will be run. (GET /automationsPeople)

Manually trigger an Automation for a specified Person. (POST /automationsPeople)

Retrieve an Automation-Person pairing. (GET /automationsPeople/{id})

Pause or unpause an Automation for a Person. (PUT /automationsPeople/{id})

Get a list of Team Inboxes (GET /teamInboxes)

Add a reaction to a corresponding reference data object, e.g. "Note" or "ThreadedReply" (POST /reactions/{refType}/{refId})

Adds a message to an existing or new Inbox App conversation. (POST /inboxApps/{inboxAppId}/message)

Update an Inbox App Message. (PUT /inboxApps/{inboxAppId}/message)

Adds a note to an Inbox App conversation. (POST /inboxApps/{inboxAppId}/note)

Updates an Inbox App conversation. (PUT /inboxApps/{inboxAppId}/conversations/{extConversationId})

Fetch a reaction (GET /reactions/{id})

Fetches a threaded reply (GET /threadedReplies/{id})

Installs your Inbox App for an account. (POST /inboxApps/install)

Retrieves participants in an Inbox App conversation. (GET /inboxApps/{inboxAppId}/conversations/{extConversationId}/participants)

Adds a participant to an Inbox App conversation. (POST /inboxApps/{inboxAppId}/conversations/{extConversationId}/participants)

Get a list of timeframes. (GET /timeframes)

Get a list of Automations (GET /automations) Defaults to limit=100 (FUB's max per page) rather than its own default of 10 — bulk requests are the common case here. If the response's _metadata shows more results remain, keep paginating: use offset for offset-based endpoints, or the _metadata.next cursor value (as the next argument) for cursor-based endpoints like notes.

Retrieve an Automation by ID. (GET /automations/{id})

Lists Inbox App installation(s) and ID(s) for your Published Inbox App on the current FUB account. (GET /inboxApps/installedApps/{publishedInboxAppId})

Adds a system confirmation message to an existing or new Inbox App conversation. (POST /inboxApps/{inboxAppId}/systemMessage)

24-hour request volume, rate-limit hits, and currently-configured limits for the calling partner system. (GET /rateLimit/usage)

Currently-configured rate limits for the calling partner system. Cheaper than /v1/rateLimit/usage (no Redis fan-out). (GET /rateLimit/limits)

List notes, optionally filtered by person. This endpoint is NOT in FUB's published API docs (only GET /notes/{id} is documented there), but the plural GET /notes endpoint works today and supports filtering by personId — confirmed against the live API. Since it's undocumented, treat it as best-effort: if FUB changes this behavior, fall back to get_note by id. (GET /notes) Defaults to limit=100. This endpoint paginates via a cursor, not offset: pass the previous response's _metadata.next value as next to get the following page.