create_group
Create a new CRM group with a name, member users, and optional lead-distribution settings such as round-robin or first-to-claim.
Instructions
Create a new group. (POST /groups)
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | Yes | The name of the group. | |
| type | No | `Agent` groups allow admins and agents and `Lender` groups allow lender role users. | Agent |
| users | Yes | An array of user IDs that will be members of this group. | |
| extraBody | No | Extra raw JSON body fields not explicitly listed above — e.g. custom.* fields when creating/updating people or deals. Keys and values are sent as-is. | |
| extraQuery | No | Extra raw query parameters not explicitly listed above — e.g. FUB custom field filters like custom.ClosingDate on /people or /deals. Keys and values are sent as-is. | |
| claimWindow | 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 and maximum of 30 minutes. | |
| distribution | No | The distribution model to utilize. (Note: Lender groups cannot be set to `first-to-claim`.) | round-robin |
| defaultPondId | No | The ID of the pond to assign unclaimed first-to-claim leads to after the claim window expires. | |
| defaultUserId | No | The ID of the user to assign unclaimed first-to-claim leads to after the claim window expires. | |
| defaultGroupId | No | The ID of the group to assign unclaimed first-to-claim leads to after the claim window expires. |