Groups

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
}

put/{sub_domain}/api/groups/{id}

Request

Base URL
https://api.commpeak.com/dialer
URL
https://api.commpeak.com/dialer/{sub_domain}/api/groups/{id}
Auth
API key in header Authorization

Path parameters

idinteger required

Group ID.

sub_domainstring required

Dialer Name (subdomain)

Request body

namestring nullable

Group name.

descriptionstring nullable

Group description.

is_deletedinteger nullable

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

rationumber nullable

Group dialing ratio.

sorting_methodstring nullable

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

feedback_after_permanent_assignmentstring nullable

Feedback after permanent assignment.

permanent_ratio_dial_as_no_ratiostring nullable

Permanent ratio dial as no ratio.

preview_direct_dial_lead_datastring nullable

Preview direct dial lead data.

background_dialing_allowedstring nullable

Background dialing allowed.

background_dialing_ratiostring nullable

Background dialing ratio.

background_dialing_feedback_prediction_timestring nullable

Background dialing feedback prediction time.

amd_enabledstring nullable

Answering-machine detection enabled.

drop_rate_periodstring nullable

Drop rate period.

outbound_ivr_enabledstring nullable

Outbound IVR enabled.

available_agent_search_timeoutstring nullable

Available agent search timeout.

Response

Successful Response

Example response

{
  "groups": [
    {
      "id": 211,
      "name": "2024 Training Group"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.