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

# Update group

`PUT /groups/{id}`

Use the Update group API request if you want to update one of the settings from a user group. You should send the user group id as a variable and fields you want to update in the request body:

#### Request Body

- `name` (string): The name of the group.
    
- `description` (string): Description of the group.
    
- `callerid_name` (string): Caller ID name for the group.
    
- `callerid_number` (string): Caller ID number for the group.
    
- `ratio` (string): Ratio for the group.
    
- `freeswitch` (string): FreeSwitch details for the group.
    
- `hard_drop_rate` (string): Hard drop rate for the group.
    
- `soft_drop_rate` (string): Soft drop rate for the group.
    
- `optimal_drop_rate` (string): Optimal drop rate for the group.
    
- `hard_ratio_increment` (string): Hard ratio increment for the group.
    
- `soft_ratio_increment` (string): Soft ratio increment for the group.
    
- `optimal_ratio_increment` (string): Optimal ratio increment for the group.
    
- `group_type` (string): Type of the group.
    
- `minimum_ratio` (string): Minimum ratio for the group.
    
- `maximum_ratio` (string): Maximum ratio for the group.
    

#### Response

The API returns a JSON object with a `groups` key, which contains an array of group objects. In the example response.

## Request body

- object
  - `callerid_name` string
  - `callerid_number` string
  - `description` string
  - `freeswitch` string
  - `group_type` string
  - `hard_drop_rate` string
  - `hard_ratio_increment` string
  - `maximum_ratio` string
  - `minimum_ratio` string
  - `name` string
  - `optimal_drop_rate` string
  - `optimal_ratio_increment` string
  - `ratio` string
  - `soft_drop_rate` string
  - `soft_ratio_increment` string

## Response `200`

Successful operation

- object
  - `groups` unknown[]
    - unknown

## Other responses

- `404` — Error

---

[API](https://skmtc.net/commpeak/apis/dialer-api-v2-0-1.md) · [All operations](https://skmtc.net/commpeak/apis/dialer-api-v2-0-1/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/commpeak/dialer-api-v2-0-1/revisions/eacecf960bb6/schema)