Update a project (partial)

patch/projects/{id}

Request

  • Base URL: https://craaft.io/api/v1
  • URL: https://craaft.io/api/v1/projects/{id}
  • Auth: HTTP bearer

Request body

namestring
descriptionstring
isFavoriteboolean
backgroundImagestring
backgroundColorstring

Hex colour (#rrggbb); mutually exclusive with backgroundImage

colorSchemestring
textColor'dark' | 'light'
showMilestonesboolean

Show or hide the milestones button in the board's top bar. Board admins only; milestones themselves are kept.

showArchivedboolean

Show or hide the archived cards button in the board's top bar. Board admins only; archived cards are kept.

showFilesboolean

Show or hide the files button in the board's top bar. Board admins only; files are kept.

showStandupboolean

Show or hide the standup button in the board's top bar. Board admins only; the u shortcut is disabled while hidden.

showActivityboolean

Show or hide the activity button in the board's top bar. Board admins only. Off by default; the feed is recorded either way.

visibility'private' | 'workspace'

Flip the board between explicit-grant access and workspace-wide implicit access. Board-admin only.

Response

Updated

idstring uuid required
workspaceIdstring uuid required
namestring required
descriptionstring
isFavoriteboolean
publicTokenstring

Non-empty when public sharing is on

backgroundImagestring
backgroundColorstring

Board background hex color (#rrggbb), empty when unset; mutually exclusive with backgroundImage

colorSchemestring
textColor'dark' | 'light'
showMilestonesboolean

Whether the board's top bar shows the milestones button. Default true.

showArchivedboolean

Whether the board's top bar shows the archived cards button. Default true.

showFilesboolean

Whether the board's top bar shows the files button. Default true.

showStandupboolean

Whether the board's top bar shows the standup button. Default true.

showActivityboolean

Whether the board's top bar shows the activity button. Default false. The /projects/{id}/activity feed answers either way.

myRole'owner' | 'admin' | 'member'

Caller's role in the project's workspace (distinct from myBoardRole).

visibility'private' | 'workspace'

private (default): only users with an explicit grant (plus workspace owners/admins) see the board. workspace: every workspace member is an implicit contributor.

myBoardRole'admin' | 'contributor'

Caller's effective role on the board. Workspace owners and admins are always admin; explicit grants resolve to admin or contributor; on a workspace-visibility board, plain workspace members default to contributor.

canUploadAttachmentsboolean

Whether cards on this board accept file attachments. Reflects the board's workspace plan (Pro), NOT the caller's own plan - so a Free user collaborating on a Pro workspace's board sees true. Matches the server's upload gate; the SPA uses it to show/hide the attachment dropzone.

totalCardsinteger
columnCountsobject
workspaceNamestring

Workspace display name; populated on list responses.

createdAtstring date-time required
updatedAtstring date-time required

Changes

No recorded changes to this operation across all 2 revisions of this API.