API Reference
API Reference
Guides

/groups

post
https://api.followupboss.com/v1/groups

Create a new group.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

🚧

Accessibility Restrictions

This is only accessible to admin accounts.

Body Params
string
required

The name of the group.

string
enum
Defaults to round-robin

The distribution model to utilize. (Note: 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*
string
enum
Defaults to Agent

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

Allowed:
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.

int32

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

int32

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

int32

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

Responses

Updated almost 3 years ago

Language
Credentials
Basic
base64
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated almost 3 years ago