Function: createWhiteboard()

function createWhiteboard(client, parameters): Promise<{
[key: string]: unknown;
  _links?:   | {
   [key: string]: unknown;
     base?: string;
     byOperation?: string;
     collection?: string;
     context?: string;
     download?: string;
     editui?: string;
     edituiv2?: string;
     next?: string;
     prev?: string;
     self?: string;
     tinyui?: string;
     webui?: string;
   }
     | null;
  authorId?: string;
  createdAt?: Date;
  id?: string;
  operations?: Record<string, any>;
  ownerId?: string;
  parentId?: string | null;
  parentType?: "page" | "embed" | "whiteboard" | "database" | "folder" | null;
  position?: number | null;
  properties?: Record<string, any>;
  spaceId?: string;
  status?:   | "deleted"
     | "any"
     | "current"
     | "historical"
     | "draft"
     | "trashed"
     | "archived";
  title?: string;
  type?: string;
  version?:   | {
   [key: string]: unknown;
     attachment?: Record<string, any>;
     authorId?: string;
     comment?: Record<string, any>;
     contributorIds?: unknown[];
     createdAt?: Date;
     message?: string | null;
     minorEdit?: boolean;
     ncsStepVersion?: string | null;
     number?: number;
   }
     | null;
}>;

Defined in: src/v2/api/whiteboard.ts:13

Creates a whiteboard in the space.

Permissions required: Permission to view the corresponding space. Permission to create a whiteboard in the space.

Parameters

Parameter	Type	Description
client	Client	-
parameters	{ body?: Record<string, any>; private?: boolean; }	-
parameters.body?	Record<string, any>	-
parameters.private?	boolean	The whiteboard will be private. Only the user who creates this whiteboard will have permission to view and edit one.

Returns

Promise<{ [key: string]: unknown; _links?: | { [key: string]: unknown; base?: string; byOperation?: string; collection?: string; context?: string; download?: string; editui?: string; edituiv2?: string; next?: string; prev?: string; self?: string; tinyui?: string; webui?: string; } | null; authorId?: string; createdAt?: Date; id?: string; operations?: Record<string, any>; ownerId?: string; parentId?: string | null; parentType?: "page" | "embed" | "whiteboard" | "database" | "folder" | null; position?: number | null; properties?: Record<string, any>; spaceId?: string; status?: | "deleted" | "any" | "current" | "historical" | "draft" | "trashed" | "archived"; title?: string; type?: string; version?: | { [key: string]: unknown; attachment?: Record<string, any>; authorId?: string; comment?: Record<string, any>; contributorIds?: unknown[]; createdAt?: Date; message?: string | null; minorEdit?: boolean; ncsStepVersion?: string | null; number?: number; } | null; }>