@shortcut/client
    Preparing search index...

    Interface UpdateGroup

    interface UpdateGroup {
        archived?: null | boolean;
        color?: null | string;
        color_key?:
            | "blue"
            | "purple"
            | "midnight-blue"
            | "orange"
            | "yellow-green"
            | "brass"
            | "gray"
            | "fuchsia"
            | "yellow"
            | "pink"
            | "sky-blue"
            | "green"
            | "red"
            | "black"
            | "slate"
            | "turquoise";
        default_workflow_id?: null
        | number;
        description?: string;
        display_icon_id?: null | string;
        member_ids?: string[];
        mention_name?: string;
        name?: string;
        workflow_ids?: number[];
    }
    Index

    Properties

    archived? color? color_key? default_workflow_id? description? display_icon_id? member_ids? mention_name? name? workflow_ids?

    Properties

    archived?: null | boolean

    Whether or not this Group is archived.

    color?: null | string

    The color you wish to use for the Group in the system.

    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"

    The color key you wish to use for the Group in the system.

    default_workflow_id?: null | number

    The ID of the default workflow for stories created in this group.

    int64

    description?: string

    The description of this Group.

    4096

    display_icon_id?: null | string

    The Icon id for the avatar of this Group.

    uuid

    member_ids?: string[]

    The Member ids to add to this Group.

    true

    mention_name?: string

    The mention name of this Group.

    1

    63

    name?: string

    The name of this Group.

    1

    63

    workflow_ids?: number[]

    The Workflow ids to add to the Group.

    Settings

    Member Visibility

    On This Page

    Properties