Skip to content

Type Alias: UpdateBoard ​

ts
type UpdateBoard = object;

Defined in: parameters/updateBoard.ts:38

Type Declaration ​

closed? ​

ts
optional closed?: boolean;

Whether the board is closed

desc? ​

ts
optional desc?: string;

A new description for the board, 0 to 16384 characters long

id ​

ts
id: string;

idOrganization? ​

ts
optional idOrganization?: string;

The id of the Workspace the board should be moved to

name? ​

ts
optional name?: string;

The new name for the board. 1 to 16384 characters long.

prefs/background? ​

ts
optional prefs/background?: 
  | string & object
  | "green"
  | "orange"
  | "red"
  | "purple"
  | "blue"
  | "sky"
  | "lime"
  | "pink"
  | "grey";

The id of a custom background or one of: blue, orange, green, red, purple, pink, lime, sky, grey

prefs/calendarFeedEnabled? ​

ts
optional prefs/calendarFeedEnabled?: boolean;

Determines whether the calendar feed is enabled or not.

prefs/cardAging? ​

ts
optional prefs/cardAging?: string & object | "pirate" | "regular";

One of: pirate, regular

prefs/cardCovers? ​

ts
optional prefs/cardCovers?: boolean;

Whether card covers should be displayed on this board

prefs/comments? ​

ts
optional prefs/comments?: 
  | "public"
  | "disabled"
  | string & object
  | "org"
  | "members"
  | "observers";

Who can comment on cards on this board. One of: disabled, members, observers, org, public

prefs/hideVotes? ​

ts
optional prefs/hideVotes?: boolean;

Determines whether the Voting Power-Up should hide who voted on cards or not.

prefs/invitations? ​

ts
optional prefs/invitations?: string & object | "members" | "admins";

Who can invite people to this board. One of: admins, members

prefs/permissionLevel? ​

ts
optional prefs/permissionLevel?: "private" | "public" | string & object | "org";

One of: org, private, public

prefs/selfJoin? ​

ts
optional prefs/selfJoin?: boolean;

Whether Workspace members can join the board themselves

prefs/voting? ​

ts
optional prefs/voting?: 
  | "public"
  | "disabled"
  | string & object
  | "org"
  | "members"
  | "observers";

Who can vote on this board. One of disabled, members, observers, org, public

subscribed? ​

ts
optional subscribed?: string;

Whether the acting user is subscribed to the board