---
title: "Update group"
method: PUT
path: "/{sub_domain}/api/groups/{id}"
tags: ["Groups"]
---

# Update group

`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`

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.**

```json
{
  "name": "Sales team",
  "ratio": 2.5
}
```

## Path parameters

- `id` integer, required: Group ID.
- `sub_domain` string, required: Dialer Name (subdomain)

## Request body

- GroupUpdateInput
  - `name` string, nullable: Group name.
  - `description` string, nullable: Group description.
  - `is_deleted` integer, nullable: Whether the group is deleted (1 = deleted, 0 = active).
  - `ratio` number, nullable: Group dialing ratio.
  - `sorting_method` string, nullable: Group lead sorting method (e.g. fifo).
  - `feedback_after_permanent_assignment` string, nullable: Feedback after permanent assignment.
  - `permanent_ratio_dial_as_no_ratio` string, nullable: Permanent ratio dial as no ratio.
  - `preview_direct_dial_lead_data` string, nullable: Preview direct dial lead data.
  - `background_dialing_allowed` string, nullable: Background dialing allowed.
  - `background_dialing_ratio` string, nullable: Background dialing ratio.
  - `background_dialing_feedback_prediction_time` string, nullable: Background dialing feedback prediction time.
  - `amd_enabled` string, nullable: Answering-machine detection enabled.
  - `drop_rate_period` string, nullable: Drop rate period.
  - `outbound_ivr_enabled` string, nullable: Outbound IVR enabled.
  - `available_agent_search_timeout` string, nullable: Available agent search timeout.

## Response `200`

Successful Response

- GroupResponse
  - `groups` GroupResult[], required
    - `id` integer, nullable, required: Group ID.
    - `name` string, nullable, required: Group name.

## Other responses

- `404`: Not Found
- `422`: Validation Error
- `500`: Internal Server Error

---

[API](https://skmtc.dev/commpeak/apis/commpeak-dialer-api.md) - [All operations](https://skmtc.dev/commpeak/apis/commpeak-dialer-api/llms.txt) - [OpenAPI document](https://skmtc.dev/commpeak/apis/commpeak-dialer-api/revisions/18c5edc07544?raw)