Update group

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.

Path Params
string
required
Body Params
string
string
string
string
string
string
string
string
string
string
string
string
string
string
string
Responses

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