RoutingGroups

Create a routing group

Creates a new routing group for the authenticated company. Returns the new group's ID.

post/api/routing-groups/create

Request

Base URL
https://core-api.getaptly.com
Auth
- API key in header x-token
- or API key in header Authorization
TypeScript
https://skmtc.dev/getaptly/apis/aptly-api/docs/api/routing-groups/create/post.ts
A function with typed inputs. Its response is checked against the schema.

namestring required

Display name for the routing group.

type'simultaneous' | 'sequential' required

Ring mode. simultaneous rings all members at once; sequential tries each in order.

destinationobject

Ring target configuration. Supports ringType of user, phone, browser, agent, or multi.

ringDurationSecondsnumber

How long (in seconds) to ring each target before moving on. Defaults to 20.

callerExperienceobject

Caller-side experience config. Set mode to ring (default) or hold-music.

maxWaitSecondsnumber

Maximum time (in seconds) a caller will wait before overflow handling triggers.

overflowobject

Overflow/voicemail config. Supports greetingText and voicemailNotification (array of emails).

Routing group created.

_idstring

ID of the created routing group.

No recorded changes to this operation across all 1 revision of this API.