nylas
    Preparing search index...

    Interface UpdateWorkspaceRequest

    Interface representing a request to update a workspace.

    Updates are issued as PATCH and address the workspace by its UUID only. At least one field must be provided.

    interface UpdateWorkspaceRequest {
        autoGroup?: boolean;
        domain?: string;
        name?: string;
        policyId?: null | string;
        rulesIds?: null | string[];
    }
    Index

    Properties

    autoGroup? domain? name? policyId? rulesIds?

    Properties

    autoGroup?: boolean

    When true, new grants whose email domain matches domain are auto-assigned. Cannot be set to true on a workspace with an empty domain.

    domain?: string

    Top-level email domain. Changing the domain is rejected by the server; the domain is effectively immutable after creation.

    name?: string

    Descriptive name for the workspace. Omitted fields are preserved.

    policyId?: null | string

    The ID of the inbox policy attached to the workspace. A UUID sets the policy, null clears it, and omitting preserves the current value.

    rulesIds?: null | string[]

    The IDs of the inbox rules attached to the workspace. An array (including an empty array) overwrites; null or omitting preserves.

    Settings

    Member Visibility

    On This Page

    Properties