Follow Up Boss icon

Follow Up Boss

Interact with the Follow Up Boss API

Actions148

Email Template → Merge

AI-generated

Summary

Merge an email template into a Follow Up Boss person's record with specified recipients.

Inputs

  • authentication (required) — Authentication method for API access. Defaults to API Key. Select OAuth2 for token-based access.
  • templateId (required) — ID of the email template to merge. Choose a numeric ID or select from the email templates list via search.
  • mergePersonId — Person ID to populate merge fields (e.g., %contact_name%). Accepts a numeric ID, a URL matching the people/view pattern, or selection from the people list.
  • recipients — List of recipients for the email To field. Each recipient includes an optional name and a required email address.

Output shape

The operation merges the selected email template into the specified person's record in Follow Up Boss, updating merge fields and sending to the provided recipients. Exact return values depend on the API response; typically the merged template record or confirmation status is returned.

Authentication defaults to API Key. Template and person IDs support ID-based lookup or list selection with search. Recipients are configured per-email with required email addresses and optional names.

Examples

Example 1: Merge a template by ID into a specific person, sending to one recipient.

authentication: API Key; templateId: { mode: 'id', value: '123' }; mergePersonId: { mode: 'id', value: '456' }; recipients: [{ to: { email: 'contact@example.com', name: 'Contact' } }]

Links

Discussion