@shortcut/client
    Preparing search index...

    Interface CreateEpic

    interface CreateEpic {
        completed_at_override?: string;
        converted_from_story_id?: null | number;
        created_at?: string;
        deadline?: null | string;
        description?: string;
        epic_state_id?: number;
        external_id?: string;
        follower_ids?: string[];
        group_id?: null | string;
        group_ids?: string[];
        labels?: CreateLabelParams[];
        milestone_id?: null | number;
        name: string;
        objective_ids?: number[];
        owner_ids?: string[];
        planned_start_date?: null | string;
        requested_by_id?: string;
        started_at_override?: string;
        state?: "in progress" | "to do" | "done";
        updated_at?: string;
    }
    Index

    Properties

    completed_at_override? converted_from_story_id? created_at? deadline? description? epic_state_id? external_id? follower_ids? group_id? group_ids? labels? milestone_id? name objective_ids? owner_ids? planned_start_date? requested_by_id? started_at_override? state? updated_at?

    Properties

    completed_at_override?: string

    A manual override for the time/date the Epic was completed.

    date-time

    Optionalconverted_from_story_id

    converted_from_story_id?: null | number

    The ID of the Story that was converted to an Epic.

    int64

    created_at?: string

    Defaults to the time/date it is created but can be set to reflect another date.

    date-time

    deadline?: null | string

    The Epic's deadline.

    date-time

    description?: string

    The Epic's description.

    100000

    epic_state_id?: number

    The ID of the Epic State.

    int64

    external_id?: string

    This field can be set to another unique ID. In the case that the Epic has been imported from another tool, the ID in the other tool can be indicated here.

    128

    follower_ids?: string[]

    An array of UUIDs for any Members you want to add as Followers on this new Epic.

    group_id?: null | string

    Deprecated The ID of the group to associate with the epic. Use group_ids.

    uuid

    group_ids?: string[]

    An array of UUIDS for Groups to which this Epic is related.

    labels?: CreateLabelParams[]

    An array of Labels attached to the Epic.

    milestone_id?: null | number

    Deprecated The ID of the Milestone this Epic is related to. Use objective_ids.

    int64

    name: string

    The Epic's name.

    1

    256

    objective_ids?: number[]

    An array of IDs for Objectives to which this Epic is related.

    owner_ids?: string[]

    An array of UUIDs for any members you want to add as Owners on this new Epic.

    planned_start_date?: null | string

    The Epic's planned start date.

    date-time

    requested_by_id?: string

    The ID of the member that requested the epic.

    uuid

    started_at_override?: string

    A manual override for the time/date the Epic was started.

    date-time

    state?: "in progress" | "to do" | "done"

    Deprecated The Epic's state (to do, in progress, or done); will be ignored when epic_state_id is set.

    updated_at?: string

    Defaults to the time/date it is created but can be set to reflect another date.

    date-time

    Settings

    Member Visibility

    On This Page

    Properties