@shortcut/client
    Preparing search index...

    Interface UpdateEpicParams

    interface UpdateEpicParams {
        archived?: boolean;
        completed_at_override?: string | null;
        deadline?: string | null;
        description?: string;
        epic_state_id?: number;
        external_id?: string;
        follower_ids?: string[];
        follower_ids_add?: string[];
        follower_ids_remove?: string[];
        name?: string;
        objective_ids?: number[];
        objective_ids_add?: number[];
        objective_ids_remove?: number[];
        owner_ids?: string[];
        owner_ids_add?: string[];
        owner_ids_remove?: string[];
        planned_start_date?: string | null;
        requested_by_id?: string;
        started_at_override?: string | null;
        team_ids?: string[];
        team_ids_add?: string[];
        team_ids_remove?: string[];
    }
    Index

    Properties

    archived? completed_at_override? deadline? description? epic_state_id? external_id? follower_ids? follower_ids_add? follower_ids_remove? name? objective_ids? objective_ids_add? objective_ids_remove? owner_ids? owner_ids_add? owner_ids_remove? planned_start_date? requested_by_id? started_at_override? team_ids? team_ids_add? team_ids_remove?

    Properties

    archived?: boolean

    Whether the Epic is archived.

    completed_at_override?: string | null

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

    date-time

    deadline?: string | null

    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

    An external ID for the Epic.

    128

    follower_ids?: string[]

    An array of UUIDs for Members to set as Followers. This will replace the current Followers on the Epic. Sending an empty array will delete all existing Followers.

    follower_ids_add?: string[]

    An array of UUIDs for Members to add as Followers. These will be added to the current Followers on the Epic.

    follower_ids_remove?: string[]

    An array of UUIDs for Members to remove as Followers. These will be removed from the current Followers on the Epic.

    name?: string

    The Epic's name.

    1

    256

    objective_ids?: number[]

    An array of IDs for Objectives to which this Epic is related. This will replace the current Objectives on the Epic. Sending an empty array will remove all existing Objectives.

    objective_ids_add?: number[]

    An array of IDs for Objectives to add to the Epic. These will be added to the current Objectives on the Epic.

    objective_ids_remove?: number[]

    An array of IDs for Objectives to remove from the Epic. These will be removed from the current Objectives on the Epic.

    owner_ids?: string[]

    An array of UUIDs for Members to set as Owners. This will replace the current Owners on the Epic. Sending an empty array will delete all existing Owners.

    owner_ids_add?: string[]

    An array of UUIDs for Members to add as Owners. These will be added to the current Owners on the Epic.

    owner_ids_remove?: string[]

    An array of UUIDs for Members to remove as Owners. These will be removed from the current Owners on the Epic.

    planned_start_date?: string | null

    The Epic's planned start date.

    date-time

    requested_by_id?: string

    The UUID of the Member that requested the Epic.

    uuid

    started_at_override?: string | null

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

    date-time

    team_ids?: string[]

    An array of UUIDs for Teams to associate with the Epic. This will replace the current Teams on the Epic. Sending an empty array will remove all existing Teams.

    team_ids_add?: string[]

    An array of UUIDs for Teams to add to the Epic. These will be added to the current Teams on the Epic.

    team_ids_remove?: string[]

    An array of UUIDs for Teams to remove from the Epic. These will be removed from the current Teams on the Epic.

    Settings

    Member Visibility

    On This Page

    Properties