Skip to main content

AddWorkspaceArgs

type AddWorkspaceArgs = {
  description?: string | null;
  domainDiscovery?: boolean;
  domainName?: string | null;
  isGuestAllowed?: boolean;
  isLinkSharingEnabled?: boolean;
  name: string;
  properties?: Record<string, unknown> | null;
  restrictEmailDomains?: boolean;
};

Arguments for creating a new workspace.

See​

https://developer.todoist.com/api/v1/#tag/Workspace/operation/create_workspace_api_v1_workspaces_post

Properties​

description?​

optional description: string | null;

Description of the workspace.

domainDiscovery?​

optional domainDiscovery: boolean;

Whether users with matching email domains can discover this workspace.

domainName?​

optional domainName: string | null;

Workspace email domain.

isGuestAllowed?​

optional isGuestAllowed: boolean;

Whether guests are allowed in the workspace.

isLinkSharingEnabled?​

optional isLinkSharingEnabled: boolean;

Whether link sharing is enabled for the workspace.

name​

name: string;

Name of the workspace.

properties?​

optional properties: Record<string, unknown> | null;

Workspace properties.

restrictEmailDomains?​

optional restrictEmailDomains: boolean;

Whether workspace invites are restricted to workspace domain.