Update a ring group

patch

https://api.emaktalk.com/api/v1/ring_groups/{id}

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; ring_group_greeting and ring_group_ringback are written only when you send them, each replaced whole. 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

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

string

required

The ring group's UUID.

Body Params

ring_group_name

string | null

Display name.

ring_group_extension

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

ring_group_enabled

boolean

Enables or disables the group.

ring_group_call_timeout

number | null

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

ring_group_timeout_category / _app / _data

string | null

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

ring_group_forward_enabled / _forward_destination

string

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

ring_group_greeting

Played to the caller before members ring. Takes a recording or a stock prompt, as a sound reference: an object whose type is one of the types below. null plays nothing.

ring_group_ringback

What the caller hears while members ring. Takes a recording, music on hold, an internet stream, a ringback tone or silence, as a sound reference: an object whose type is one of the types below. null keeps the caller's current ringback.

ring_group_distinctive_ring, ring_group_cid_name_prefix, ring_group_missed_call_app, ring_group_missed_call_data, ring_group_strategy, ring_group_description, ring_group_follow_me_enabled, ring_group_call_forward_enabled

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

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200The ring group was updated; the updated group is not returned, so re-read it.

403Your API key does not have the Admin role.

404No ring group on your account has that id.

409A call flow owns this ring group — edit the flow instead.

502The ownership check could not be completed, so nothing was written.

503try_again: your account's sounds couldn't be read just now, and nothing was changed. Wait the Retry-After seconds, then send the same request again.