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

    Interface UpdateBoard

    interface UpdateBoard {
        background?: string;
        blue?: string;
        calendarFeedEnabled?: boolean;
        cardAging?: string;
        cardCovers?: boolean;
        closed?: boolean;
        comments?: string;
        desc?: string;
        green?: string;
        hideVotes?: boolean;
        id: string;
        idOrganization?: string;
        invitations?: string;
        labelNames?: {
            blue?: string;
            green?: string;
            orange?: string;
            purple?: string;
            red?: string;
            yellow?: string;
        };
        name?: string;
        orange?: string;
        permissionLevel?: string;
        prefs?: {
            background?: | "blue"
            | "orange"
            | "green"
            | "red"
            | "purple"
            | "pink"
            | "lime"
            | "sky"
            | "grey";
            calendarFeedEnabled?: boolean;
            cardAging?: "pirate"
            | "regular";
            cardCovers?: boolean;
            comments?: "public" | "disabled" | "org" | "members" | "observers";
            hideVotes?: boolean;
            invitations?: "admins" | "members";
            permissionLevel?: "private" | "public" | "org";
            selfJoin?: boolean;
            voting?: "public" | "disabled" | "org" | "members" | "observers";
        };
        purple?: string;
        red?: string;
        selfJoin?: boolean;
        subscribed?: boolean;
        voting?: string;
        yellow?: string;
    }
    Index

    Properties

    background? blue? calendarFeedEnabled? cardAging? cardCovers? closed? comments? desc? green? hideVotes? id idOrganization? invitations? labelNames? name? orange? permissionLevel? prefs? purple? red? selfJoin? subscribed? voting? yellow?

    Properties

    background?: string

    Use prefs.background instead.

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

    blue?: string

    Use labelNames.blue instead.

    Name for the blue label. 1 to 16384 characters long

    calendarFeedEnabled?: boolean

    Use prefs.calendarFeedEnabled instead.

    Determines whether the calendar feed is enabled or not.

    cardAging?: string

    Use prefs.cardAging instead.

    One of: pirate | regular

    cardCovers?: boolean

    Use prefs.cardCovers instead.

    Whether card covers should be displayed on this board

    closed?: boolean

    Whether the board is closed

    comments?: string

    Use prefs.comments instead.

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

    desc?: string

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

    green?: string

    Use labelNames.green instead.

    Name for the green label. 1 to 16384 characters long

    hideVotes?: boolean

    Use prefs.hideVotes instead.

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

    id: string
    idOrganization?: string

    The id of the team the board should be moved to

    invitations?: string

    Use prefs.invitations instead.

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

    labelNames?: {
        blue?: string;
        green?: string;
        orange?: string;
        purple?: string;
        red?: string;
        yellow?: string;
    }

    Type declaration

    • Optionalblue?: string

      Name for the blue label. 1 to 16384 characters long

    • Optionalgreen?: string

      Name for the green label. 1 to 16384 characters long

    • Optionalorange?: string

      Name for the orange label. 1 to 16384 characters long

    • Optionalpurple?: string

      Name for the purple label. 1 to 16384 characters long

    • Optionalred?: string

      Name for the red label. 1 to 16384 characters long

    • Optionalyellow?: string

      Name for the yellow label. 1 to 16384 characters long

    name?: string

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

    orange?: string

    Use labelNames.orange instead.

    Name for the orange label. 1 to 16384 characters long

    permissionLevel?: string

    Use prefs.permissionLevel instead.

    One of: org | private | public

    prefs?: {
        background?:
            | "blue"
            | "orange"
            | "green"
            | "red"
            | "purple"
            | "pink"
            | "lime"
            | "sky"
            | "grey";
        calendarFeedEnabled?: boolean;
        cardAging?: "pirate"
        | "regular";
        cardCovers?: boolean;
        comments?: "public" | "disabled" | "org" | "members" | "observers";
        hideVotes?: boolean;
        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

    • OptionalcalendarFeedEnabled?: boolean

      Determines whether the calendar feed is enabled or not.

    • OptionalcardAging?: "pirate" | "regular"

      One of: pirate, regular

    • OptionalcardCovers?: boolean

      Whether card covers should be displayed on this board

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

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

    • OptionalhideVotes?: boolean

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

    • Optionalinvitations?: "admins" | "members"

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

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

      One of: org, private, public

    • OptionalselfJoin?: boolean

      Whether team members can join the board themselves

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

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

    purple?: string

    Use labelNames.purple instead.

    Name for the purple label. 1 to 16384 characters long

    red?: string

    Use labelNames.red instead.

    Name for the red label. 1 to 16384 characters long

    selfJoin?: boolean

    Use prefs.selfJoin instead.

    Whether team members can join the board themselves

    subscribed?: boolean

    Whether the acting user is subscribed to the board

    voting?: string

    Use prefs.voting instead.

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

    yellow?: string

    Use labelNames.yellow instead.

    Name for the yellow label. 1 to 16384 characters long

    Settings

    Member Visibility

    On This Page

    Properties