/groups/:id

put

https://api.followupboss.com/v1/groups/{id}

Update a group.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

🚧
Accessibility Restrictions
This is only accessible to admin accounts.

Path Params

string

required

The id of the group.

Body Params

name

string

required

The name of the group.

distribution

string

enum

Defaults to round-robin

The distribution model to utilize. Lender groups cannot be set to first-to-claim.

Allowed:

users

array of int32s

required

An array of user IDs that will be members of this group.

users*

type

string

enum

Defaults to Agent

Agent groups allow admins and agents and Lender groups allow lender role users.

Allowed:

claimWindow

int32

Defaults to 1800

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.

defaultGroupId

int32

The ID of the group to assign unclaimed first-to-claim leads to after the claim window expires.

defaultPondId

int32

The ID of the pond to assign unclaimed first-to-claim leads to after the claim window expires.

defaultUserId

int32

The ID of the user to assign unclaimed first-to-claim leads to after the claim window expires.

Responses

🚧Accessibility Restrictions

200200

400400

🚧
Accessibility Restrictions