Trello.js - API library
    Preparing search index...

    Interface CreateBoard

    interface CreateBoard {
        defaultLabels?: boolean;
        defaultLists?: boolean;
        desc?: string;
        idBoardSource?: string;
        idOrganization?: string;
        keepFromSource?: string;
        name: string;
        powerUps?: string;
        prefs?: {
            background?:
                | "blue"
                | "orange"
                | "green"
                | "red"
                | "purple"
                | "pink"
                | "lime"
                | "sky"
                | "grey";
            cardAging?: "pirate"
            | "regular";
            cardCovers?: boolean;
            comments?: "public" | "disabled" | "org" | "members" | "observers";
            invitations?: "admins" | "members";
            permissionLevel?: "private" | "public" | "org";
            selfJoin?: boolean;
            voting?: "public" | "disabled" | "org" | "members" | "observers";
        };
        prefsBackground?: string;
        prefsCardAging?: string;
        prefsCardCovers?: boolean;
        prefsComments?: string;
        prefsInvitations?: string;
        prefsPermissionLevel?: string;
        prefsSelfJoin?: boolean;
        prefsVoting?: string;
    }
    Index

    Properties

    defaultLabels? defaultLists? desc? idBoardSource? idOrganization? keepFromSource? name powerUps? prefs? prefsBackground? prefsCardAging? prefsCardCovers? prefsComments? prefsInvitations? prefsPermissionLevel? prefsSelfJoin? prefsVoting?

    Properties

    defaultLabels?: boolean

    Determines whether to use the default set of labels.

    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?: string

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

    idBoardSource?: string

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

    idOrganization?: string

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

    keepFromSource?: string

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

    name: string

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

    powerUps?: string

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

    prefs?: {
        background?:
            | "blue"
            | "orange"
            | "green"
            | "red"
            | "purple"
            | "pink"
            | "lime"
            | "sky"
            | "grey";
        cardAging?: "pirate"
        | "regular";
        cardCovers?: boolean;
        comments?: "public" | "disabled" | "org" | "members" | "observers";
        invitations?: "admins" | "members";
        permissionLevel?: "private" | "public" | "org";
        selfJoin?: boolean;
        voting?: "public" | "disabled" | "org" | "members" | "observers";
    }

    Type declaration

    • Optionalbackground?:
          | "blue"
          | "orange"
          | "green"
          | "red"
          | "purple"
          | "pink"
          | "lime"
          | "sky"
          | "grey"

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

    • OptionalcardAging?: "pirate" | "regular"

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

    • OptionalcardCovers?: boolean

      Determines whether card covers are enabled.

    • Optionalcomments?: "public" | "disabled" | "org" | "members" | "observers"

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

    • Optionalinvitations?: "admins" | "members"

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

    • OptionalpermissionLevel?: "private" | "public" | "org"

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

    • OptionalselfJoin?: boolean

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

    • Optionalvoting?: "public" | "disabled" | "org" | "members" | "observers"

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

    prefsBackground?: string

    Use prefs.background instead.

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

    prefsCardAging?: string

    Use prefs.cardAging instead.

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

    prefsCardCovers?: boolean

    Use prefs.cardCovers instead.

    Determines whether card covers are enabled.

    prefsComments?: string

    Use prefs.comments instead.

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

    prefsInvitations?: string

    Use prefs.invitations instead.

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

    prefsPermissionLevel?: string

    Use prefs.permissionLevel instead.

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

    prefsSelfJoin?: boolean

    Use prefs.selfJoin instead.

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

    prefsVoting?: string

    Use prefs.voting instead.

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

    Settings

    Member Visibility

    On This Page

    Properties