Update group

Update the settings of a user group identified by id.

When to use. Change a group's name, description, dialing ratio or other settings. Send the group id in the path and only the fields you want to change in the request body. Any field not listed in the request schema is ignored.

Returns. The updated group, wrapped as { "groups": [ <group> ] }. Returns 404 if no group matches the id.

Example.

{
  "name": "Sales team",
  "ratio": 2.5
}
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
integer
required

Group ID.

Body Params

Writable fields for updating a user group. Any field not listed here is ignored.

string

Group name.

string

Group description.

integer

Whether the group is deleted (1 = deleted, 0 = active).

float

Group dialing ratio.

string

Group lead sorting method (e.g. fifo).

string

Feedback after permanent assignment.

string

Permanent ratio dial as no ratio.

string

Preview direct dial lead data.

string

Background dialing allowed.

string | null

Background dialing ratio.

string | null

Background dialing feedback prediction time.

string

Answering-machine detection enabled.

string

Drop rate period.

string

Outbound IVR enabled.

string

Available agent search timeout.

Responses

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