Type Alias: CreateBoard

type CreateBoard = object;

Defined in: parameters/createBoard.ts:45

Type Declaration

defaultLabels?

optional defaultLabels?: boolean;

Determines whether to use the default set of labels.

defaultLists?

optional defaultLists?: boolean;

Determines whether to add the default set of lists to a board (To Do, Doing, Done). It is ignored if idBoardSource is provided.

desc?

optional desc?: string;

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

idBoardSource?

optional idBoardSource?: string;

The id of a board to copy into the new board.

idOrganization?

optional idOrganization?: string;

The id or name of the Workspace the board should belong to.

keepFromSource?

optional keepFromSource?: "none" | string & object | "cards";

To keep cards from the original board pass in the value cards

name

name: string;

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

powerUps?

optional powerUps?: "all" | "calendar" | string & object | "voting" | "cardAging" | "recap";

The Power-Ups that should be enabled on the new board. One of: all, calendar, cardAging, recap, voting.

prefsBackground?

optional prefsBackground?: 
  | 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.

prefsCardAging?

optional prefsCardAging?: string & object | "pirate" | "regular";

Determines the type of card aging that should take place on the board if card aging is enabled. One of: pirate, regular.

prefsCardCovers?

optional prefsCardCovers?: boolean;

Determines whether card covers are enabled.

prefsComments?

optional prefsComments?: 
  | "public"
  | "disabled"
  | string & object
  | "org"
  | "members"
  | "observers";

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

prefsInvitations?

optional prefsInvitations?: string & object | "members" | "admins";

Determines what types of members can invite users to join. One of: admins, members.

prefsPermissionLevel?

optional prefsPermissionLevel?: "private" | "public" | string & object | "org";

The permissions level of the board. One of: org, private, public.

prefsSelfJoin?

optional prefsSelfJoin?: boolean;

Determines whether users can join the boards themselves or whether they have to be invited.

prefsVoting?

optional prefsVoting?: 
  | "public"
  | "disabled"
  | string & object
  | "org"
  | "members"
  | "observers";

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