Interface UpdateGroup

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

Properties

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

Properties

Optionalarchived

archived?: boolean

Whether or not this Group is archived.

Optionalcolor

color?: string

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

Format

css-color

Min Length

1

Pattern

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

Optionalcolor_key

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.

Optionaldescription

description?: string

The description of this Group.

Optionaldisplay_icon_id

display_icon_id?: string

The Icon id for the avatar of this Group.

Format

uuid

Optionalmember_ids

member_ids?: string[]

The Member ids to add to this Group.

Unique Items

true

Optionalmention_name

mention_name?: string

The mention name of this Group.

Min Length

1

Max Length

63

Optionalname

name?: string

The name of this Group.

Min Length

1

Max Length

63

Optionalworkflow_ids

workflow_ids?: number[]

The Workflow ids to add to the Group.

Settings

Member Visibility

On This Page

Properties