Skip to main content
POST
Create a Loop ring group

Authorizations

Authorization
string
header
required

API key (fam_..., created under Settings → API Keys) or an OAuth 2.0 access token (fam_at_...). Keys can be restricted to scopes such as assistants:read, calls:write, campaigns:write, automations:read, dashboards:read, dashboards:write, leads:write, segments:write, loop:read, loop:write, phone_numbers:write, sip_trunks:write, knowledge:write, voices:read, billing:read, settings:write, platform:read, platform:write; a *:write scope implies the matching *:read. Automation and dashboard endpoints also accept the legacy calls:* scope. Keys without scope restrictions have full access.

Body

application/json
name
string
required
Required string length: 1 - 120
strategy
enum<string>
required
Available options:
simultaneous,
sequential,
round_robin
ring_timeout_seconds
integer
required
Required range: 5 <= x <= 120
presence_required
boolean
required
active
boolean
required
member_ids
string<uuid>[]
deprecated

Legacy member list. Use members for ordered delay settings.

Maximum array length: 100
members
object[]

Members in ringing order with an optional pre-ring delay.

Maximum array length: 100

Response

Created ring group.

data
object
required