Skip to main content

UpdateWorkspaceArgs

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

Arguments for updating an existing workspace.

See​

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

Properties​

description?​

optional description: string | null;

Updated workspace description.

domainDiscovery?​

optional domainDiscovery: boolean;

Updated domain discovery setting.

domainName?​

optional domainName: string | null;

Updated workspace email domain.

isCollapsed?​

optional isCollapsed: boolean;

Updated collapse state for current user.

isGuestAllowed?​

optional isGuestAllowed: boolean | null;

Updated guest access status.

isLinkSharingEnabled?​

optional isLinkSharingEnabled: boolean;

Updated link sharing status.

name?​

optional name: string;

Updated workspace name.

properties?​

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

Updated workspace properties.

restrictEmailDomains?​

optional restrictEmailDomains: boolean;

Updated email domain restriction setting.