Update a ring group

Updates a ring group in place: your body is merged over the current group, then the group and its call routing are rewritten. Every key you send is applied, including an explicit null, so send only the fields you mean to change. Destinations follow the presence of ring_group_destinations — omit it to leave members untouched, send an array to replace the whole set, or send null to clear them all. The updated group is not returned, so re-read it with GET /api/v1/ring_groups/{id}. Identity fields are not settable here: the record's own id, its account, and its call-routing id are always taken from the stored record, and sending them has no effect.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The ring group's UUID.

Body Params
string | null

Display name.

string | null

The number the group answers on. A number in the reserved call-flow range is refused with 400 (code reserved_extension_band).

ring_group_destinations
array | null

Omit to leave the members untouched, send an array to replace the whole set, or send null to clear every destination. Any other value is 400.

ring_group_destinations
boolean

Enables or disables the group.

number | null

Seconds the group rings before the no-answer action takes over.

string | null

The no-answer destination: its category, the action taken and the action's argument.

string

Whether every call is forwarded instead of ringing members, and where it goes.

string

Any other ring-group field may be sent as well; your body is merged over the current group.

Responses

401

Missing or invalid API key.

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