Sign in

v1

latestOpenAPI 3.0.32026-07-13218142597.2 KB
Whiteboard

Create whiteboard

Creates a whiteboard in the space.

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

post/whiteboards

Query parameters

privateboolean

The whiteboard will be private. Only the user who creates this whiteboard will have permission to view and edit one.

Request body

spaceIdstring required

ID of the space.

titlestring

Title of the whiteboard.

parentIdstring

The parent content ID of the whiteboard.

templateKey'2x2-prioritization' | '4ls-retro' | 'annual-calendar' | 'brainwriting' | 'concept-map' | 'crazy-8s' | 'daily-sync' | 'disruptive-brainstorm' | 'dot-voting' | 'elevator-pitch' | 'flow-chart' | 'gap-analysis' | 'ice-breakers' | 'incident-postmortem' | 'journey-mapping-kit' | 'kanban-board' | 'lean-coffee' | 'network-of-teams' | 'org-chart' | 'pi-planning' | 'prioritization' | 'prioritization-experiment' | 'product-roadmap' | 'product-vision-board' | 'rice' | 'sailboat-retro' | 'service-blueprint' | 'simple-retrospective' | 'sprint-planning' | 'sticky-note-pack' | 'swimlanes' | 'team-formation-guide' | 'timeline' | 'timeline-workflow' | 'user-story-map' | 'workflow' | 'vision-board' | 'venn-diagram' | 'storyboard' | 'action-plan' | 'root-cause-analysis' | 'executive-summary' | 'stakeholder-mapping' | 'annual-calendar-2025-2026' | 'health-monitor' | 'okr-planning' | 'swot-analysis' | 'poker-planning' | 'fishbone-diagram' | 'risk-assessment' | 'bounded-context' | 'hopes-and-fears' | 'swimlane-vertical'

Providing a template key will add that template to the new whiteboard.

locale'de-DE' | 'cs-CZ' | 'ko-KR' | 'fr-FR' | 'it-IT' | 'ja-JP' | 'nl-NL' | 'nb-NO' | 'da-DK' | 'sv-SE' | 'fi-FI' | 'ru-RU' | 'pl-PL' | 'tr-TR' | 'hu-HU' | 'en-GB' | 'en-US' | 'pt-BR' | 'zh-CN' | 'zh-TW' | 'es-ES'

If templateKey is provided, locale will decide which language the template will be created with. If locale is omitted, the user's locale will be used.

Response

Returned if the whiteboard was successfully created.

idstring

ID of the whiteboard.

typestring

The content type of the object.

status'current' | 'draft' | 'archived' | 'historical' | 'trashed' | 'deleted' | 'any'

The status of the content.

titlestring

Title of the whiteboard.

parentIdstring

ID of the parent content, or null if there is no parent content.

parentType'page' | 'whiteboard' | 'database' | 'embed' | 'folder'

Content type of the parent, or null if there is no parent.

positioninteger nullable

Position of the whiteboard within the given parent page tree.

authorIdstring

The account ID of the user who created this whiteboard originally.

ownerIdstring

The account ID of the user who owns this whiteboard.

createdAtstring date-time

Date and time when the whiteboard was created. In format "YYYY-MM-DDTHH:mm:ss.sssZ".

spaceIdstring

ID of the space the whiteboard is in.