Create Sub-workspace
Creates a new sub-workspace under the primary workspace that owns the API key. The sub-workspace is a full workspace (own assistants, numbers, campaigns, call history, members) that starts with zero balance or credit limit and zero concurrency; allocate to it afterwards. Every member of the primary is given inherited access to it. The first sub-workspace turns the primary into a family in individual billing mode.
When to use
- Onboarding a new client, brand, or team that needs its own isolated assistants, numbers, and call history.
- Automating tenant provisioning from your own admin system.
Request parameters
Integration notes
- Authenticate with the primary workspace’s API key. A sub-workspace’s key returns
400. - Store the returned
sub_workspace.id; every allocation call needs it. - The first sub-workspace 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 sub-workspace.
- The response never contains an API key. See Sub-workspaces for how to get one.
Error responses
- 400:
Sub-workspaces cannot have their own sub-workspaces.— the key belongs to a sub-workspace. - 401: Invalid or missing API key.
- 403:
Sub-workspaces are not enabled for this workspace. - 422: Missing or blank
name, or a name longer than 100 characters.
Example
After creation
Give the sub-workspace capacity with Allocate Concurrency and, in an individual family, a credit limit or balance. Then generate its API key in the dashboard and create an assistant with that key.Headers
(Required) The API key of the PRIMARY workspace. A sub-workspace's key is refused with 400.
"7251cb4b-3373-43a4-844c-b27a1d45e0c9"
Body
(Required) Display name of the new sub-workspace, 1-100 characters. Surrounding whitespace is trimmed.
1 - 100"Mumbai Collections"