Skip to navigation

PM · Boards · Create a new PM board with optional initial status columns

View as Markdown

Create a new PM board in the workspace. Optionally seed it with an initial set of statuses (columns) in one call via the statuses field. primary_type is pm (default) or blogger — lowercase, no other values. access controls visibility: 0=PRIVATE, 1=PROTECTED, 2=PUBLIC.

Authentication

AuthorizationApi-Key

Header authentication of the form Api-Key <token>

OR
AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Headers

OrganizationstringOptional

Workspace (organization) ID the request is scoped to.

SpacestringOptional

Optional sub-space ID for further scoping inside the workspace.

Request

This endpoint expects an object.
titlestringOptional<=2048 characters

Board title. Defaults to "{workspace} Project" if omitted.

descriptionstringOptional
Board description.
accessintegerOptional

Board access: 0=PRIVATE (default), 1=PROTECTED (workspace-shared), 2=PUBLIC.

primary_typeenumOptionalDefaults to pm

Board type discriminator. Lowercase; pm for task boards, blogger for blog boards.

Allowed values:
statuseslist of objectsOptional

Optional inline status definitions to seed the board with. If omitted, the board gets the 4 default statuses (Draft / To Do / In Progress / Completed).

extramap from strings to anyOptional

Free-form board configuration (_config on the model).

Response

Board created.