@shortcut/client
    Preparing search index...

    Interface UpdateTeamParams

    interface UpdateTeamParams {
        archived?: boolean;
        card_aging_mode?: "off" | "gradual" | "immediate" | null;
        card_aging_threshold_days?: number | null;
        color?: string | null;
        color_key?:
            | "blue"
            | "purple"
            | "midnight-blue"
            | "orange"
            | "yellow-green"
            | "brass"
            | "gray"
            | "fuchsia"
            | "yellow"
            | "pink"
            | "sky-blue"
            | "green"
            | "red"
            | "black"
            | "slate"
            | "turquoise"
            | null;
        default_workflow_id?: number
        | null;
        description?: string;
        member_ids?: string[];
        member_ids_add?: string[];
        member_ids_remove?: string[];
        mention_name?: string;
        name?: string;
        workflow_ids?: number[];
        workflow_ids_add?: number[];
        workflow_ids_remove?: number[];
    }
    Index

    Properties

    archived? card_aging_mode? card_aging_threshold_days? color? color_key? default_workflow_id? description? member_ids? member_ids_add? member_ids_remove? mention_name? name? workflow_ids? workflow_ids_add? workflow_ids_remove?

    Properties

    archived?: boolean

    Whether the Team is archived.

    card_aging_mode?: "off" | "gradual" | "immediate" | null

    The card aging mode for stories in this Team: "gradual" (fixed fade steps at 1, 2, and 4 weeks), "immediate", or "off" (explicitly disabled for this Team). Set to null to inherit the Workspace default (also clears card_aging_threshold_days).

    card_aging_threshold_days?: number | null

    The number of days an in-progress Story can go without activity before it is considered stale. Required when card_aging_mode is "immediate"; not allowed otherwise.

    int64

    color?: string | null

    The hex color to be displayed with the Team (for example, "#ff0000"). Set to null to clear.

    css-color

    1

    ^#[a-fA-F0-9]{6}$

    color_key?:
        | "blue"
        | "purple"
        | "midnight-blue"
        | "orange"
        | "yellow-green"
        | "brass"
        | "gray"
        | "fuchsia"
        | "yellow"
        | "pink"
        | "sky-blue"
        | "green"
        | "red"
        | "black"
        | "slate"
        | "turquoise"
        | null

    The color key to be displayed with the Team. Set to null to clear.

    default_workflow_id?: number | null

    The ID of the default Workflow for Stories created in this Team. Set to null to clear.

    int64

    description?: string

    The Team's description.

    4096

    member_ids?: string[]

    An array of UUIDs for Members to set as the Team's members. Replaces current members.

    member_ids_add?: string[]

    An array of UUIDs for Members to add to the Team.

    member_ids_remove?: string[]

    An array of UUIDs for Members to remove from the Team.

    mention_name?: string

    The Team's mention name.

    1

    ^[a-z0-9._-]+$

    name?: string

    The Team's name.

    1

    63

    workflow_ids?: number[]

    An array of IDs for Workflows to associate with the Team. Replaces current Workflows.

    workflow_ids_add?: number[]

    An array of IDs for Workflows to add to the Team.

    workflow_ids_remove?: number[]

    An array of IDs for Workflows to remove from the Team.

    Settings

    Member Visibility

    On This Page

    Properties