Interface CreateWorkspaceRequest

Interface representing a request to create a workspace.

interface CreateWorkspaceRequest {
    autoGroup?: boolean;
    domain?: string;
    name: string;
    policyId?: string;
    ruleIds?: string[];
}

Properties

autoGroup?: boolean

When true, new grants whose email domain matches domain are auto-assigned. Defaults server-side to true when a domain is provided, false otherwise.

domain?: string

Top-level email domain for the workspace. Optional: when omitted along with autoGroup, an empty-domain workspace is created.

name: string

Descriptive name for the workspace.

policyId?: string

The ID of the inbox policy to attach to the workspace.

ruleIds?: string[]

The IDs of the inbox rules to attach to the workspace.