Skip to main content
POST
Create Ringg Space
Use it for a client, brand or team that needs its own agents, numbers and call history. The Ringg Space’s default agents and telephony are set up for it, and its currency, account type and billing plan are copied from the primary.

Notes

  • Store the returned sub_workspace.id; every allocation call needs it.
  • The first Ringg Space you create turns the primary into a family in individual billing mode. Contact Ringg support if the family should use common billing instead.
  • Every member of the primary automatically gets access to the new Ringg Space.

Errors

  • 400: Sub-workspaces cannot have their own sub-workspaces. — the key belongs to a Ringg Space that has Ringg Spaces enabled.
  • 401: Invalid or missing API key.
  • 403: Sub-workspaces are not enabled for this workspace. — Ringg Spaces are not enabled on the primary, or the key belongs to a Ringg Space.
  • 422: Missing or blank name, or a name longer than 100 characters.

After creation

Give the Ringg Space capacity with Allocate Concurrency and, in an individual family, a credit limit or balance. The response never contains an API key: generate one in the dashboard (Ringg Spaces), then create an agent with that key.

Authorizations

X-API-KEY
string
header
required

Headers

X-API-KEY
string
required

(Required) The API key of the PRIMARY workspace. A Ringg Space's own key is refused (403, or 400 if Ringg Spaces are enabled on it).

Example:

"rg_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

Body

application/json
name
string
required

(Required) Display name of the new Ringg Space, 1-100 characters. Surrounding whitespace is trimmed.

Required string length: 1 - 100
Example:

"Mumbai Collections"

Response

Successful Response: The new Ringg Space.

message
string
Example:

"Sub-workspace Mumbai Collections created successfully"

sub_workspace
object