Follow Up Boss icon

Follow Up Boss

Interact with the Follow Up Boss API

Actions148

Group → Update

AI-generated

Summary

Update a Follow Up Boss group's name, members, distribution model, type, and default lead assignment settings.

Inputs

  • id (required) — ID of the group to update. Choose from the list, or specify an ID.
  • name — Name of the group.
  • users — A list of user IDs that will be members of this group.
  • distribution — The distribution model to utilize.
  • type — Agent groups allow admins and agents and Lender groups allow lender role users.
  • claimWindow — Number of seconds to allow someone to claim a lead in a first-to-claim group before reassigning.
  • defaultGroupId — The group to assign unclaimed leads to.
  • defaultPondId — The pond to assign unclaimed leads to.
  • defaultUserId — The user to assign unclaimed leads to.

Output shape

The updated group object as returned by the Follow Up Boss API.

Conditional parameters (claimWindow, defaultGroupId, defaultPondId, defaultUserId) are only applicable when distribution is set to first-to-claim.

Examples

Example 1: Rename a group and add members

id: 123; name: Engineering; users: [456, 789]

Links

Discussion