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.

string
required

Dialer Name (subdomain)

Body Params

Group name.

Group description.

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

Group dialing ratio.

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

Feedback after permanent assignment.

Permanent ratio dial as no ratio.

Preview direct dial lead data.

Background dialing allowed.

Background dialing ratio.

Background dialing feedback prediction time.

Answering-machine detection enabled.

Drop rate period.

Outbound IVR enabled.

Available agent search timeout.

Responses

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