@shortcut/client
    Preparing search index...

    Interface UpdateStoryParams

    interface UpdateStoryParams {
        archived?: boolean;
        custom_field_values?: CreateCustomFieldValueParams[];
        custom_field_values_add?: CreateCustomFieldValueParams[];
        custom_field_values_remove?: CreateCustomFieldValueParams[];
        deadline?: string | null;
        description?: string;
        epic_id?: number | null;
        estimate?: number | null;
        external_id?: string;
        external_links?: string[];
        external_links_add?: string[];
        external_links_remove?: string[];
        file_ids?: number[];
        file_ids_add?: number[];
        file_ids_remove?: number[];
        follower_ids?: string[];
        follower_ids_add?: string[];
        follower_ids_remove?: string[];
        iteration_id?: number | null;
        label_ids?: number[];
        label_ids_add?: number[];
        label_ids_remove?: number[];
        linked_file_ids?: number[];
        linked_file_ids_add?: number[];
        linked_file_ids_remove?: number[];
        name?: string;
        owner_ids?: string[];
        owner_ids_add?: string[];
        owner_ids_remove?: string[];
        parent_story_id?: number | null;
        project_id?: number | null;
        requester_id?: string;
        set_position?: StorySetPosition;
        story_type?: "feature" | "chore" | "bug";
        team_id?: string | null;
        workflow_state_id?: number;
    }
    Index

    Properties

    archived? custom_field_values? custom_field_values_add? custom_field_values_remove? deadline? description? epic_id? estimate? external_id? external_links? external_links_add? external_links_remove? file_ids? file_ids_add? file_ids_remove? follower_ids? follower_ids_add? follower_ids_remove? iteration_id? label_ids? label_ids_add? label_ids_remove? linked_file_ids? linked_file_ids_add? linked_file_ids_remove? name? owner_ids? owner_ids_add? owner_ids_remove? parent_story_id? project_id? requester_id? set_position? story_type? team_id? workflow_state_id?

    Properties

    archived?: boolean

    Controls the Story's archived state.

    custom_field_values?: CreateCustomFieldValueParams[]

    An array of objects specifying a CustomField ID and CustomFieldEnumValue ID that represents an assertion of some value for a Custom Field. This will replace the current Custom Field values on the Story. Sending an empty array will delete all existing Custom Field values.

    custom_field_values_add?: CreateCustomFieldValueParams[]

    An array of objects specifying a CustomField ID and CustomFieldEnumValue ID that represents an assertion of some value for a Custom Field. These will be added to the current Custom Field values on the Story.

    custom_field_values_remove?: CreateCustomFieldValueParams[]

    An array of objects specifying a CustomField ID and CustomFieldEnumValue ID that represents an assertion of some value for a Custom Field. These will be removed from the current Custom Field values on the Story.

    deadline?: string | null

    The due date of the Story.

    date-time

    description?: string

    The description of the story.

    100000

    epic_id?: number | null

    The ID of the Epic the Story belongs to.

    int64

    estimate?: number | null

    The numeric point estimate of the Story. Can also be null, which means unestimated.

    int64

    external_id?: string

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

    128

    external_links?: string[]

    An array of External Links associated with the Story. This will replace the current External Links on the Story. Sending an empty array will delete all existing External Links.

    true

    external_links_add?: string[]

    An array of External Links associated with the Story. These will be added to the current External Links on the Story.

    true

    external_links_remove?: string[]

    An array of External Links associated with the Story. These will be removed from the current External Links on the Story.

    true

    file_ids?: number[]

    An array of IDs of Files attached to the Story. This will replace the current Files on the Story. Sending an empty array will delete all existing Files.

    true

    file_ids_add?: number[]

    An array of IDs of Files attached to the Story. These will be added to the current files on the Story.

    true

    file_ids_remove?: number[]

    An array of IDs of Files attached to the Story. These will be added to the current files on the Story.

    true

    follower_ids?: string[]

    An array of UUIDs of the Members that follow this Story. This will replace the current Followers on the Story. Sending an empty array will delete all existing Followers.

    true

    follower_ids_add?: string[]

    An array of UUIDs of the Members that follow this Story. These will be added to the current followers on the Story.

    true

    follower_ids_remove?: string[]

    An array of UUIDs of the Members that follow this Story. These will be removed from the current followers on the Story.

    true

    iteration_id?: number | null

    The ID of the Iteration the Story belongs to.

    int64

    label_ids?: number[]

    Labels to attach to the Story. This will replace the current Labels on the Story. Sending an empty array will delete all existing Labels.

    true

    label_ids_add?: number[]

    Labels to attach to the Story. These will be added to the current Labels on the Story.

    true

    label_ids_remove?: number[]

    Labels to detach from the Story. These will be removed to the current Labels on the Story.

    true

    linked_file_ids?: number[]

    An array of IDs of Linked Files attached to the Story. This will replace the current Linked Files on the Story. Sending an empty array will delete all existing Linked Files.

    true

    linked_file_ids_add?: number[]

    An array of IDs of Linked Files attached to the Story. These will be added to the current files on the Story.

    true

    linked_file_ids_remove?: number[]

    An array of IDs of Linked Files attached to the Story. These will be added to the current files on the Story.

    true

    name?: string

    The name of the Story.

    1

    512

    owner_ids?: string[]

    An array of UUIDs of the Members that own this Story. This will replace the current Owners on the Story. Sending an empty array will delete all existing Owners.

    true

    owner_ids_add?: string[]

    An array of UUIDs of the Members that own this Story. These will be added to the current owners on the Story.

    true

    owner_ids_remove?: string[]

    An array of UUIDs of the Members that own this Story. These will be removed from the current owners on the Story.

    true

    Optionalparent_story_id

    parent_story_id?: number | null

    The ID of the parent Story to associate with this Story (making the Story a sub-task). Field only applicable when Sub-task feature is enabled.

    int64

    project_id?: number | null

    The ID of the Project the Story belongs to.

    int64

    requester_id?: string

    The ID of the Member that requested the Story. Will default to the Member making the API call if not provided.

    uuid

    set_position?: StorySetPosition

    One of "first", "last", "before", or "after". This can be used to move the given story to the first or last position in the Workflow State, or before or after a given Story.

    Optionalstory_type

    story_type?: "feature" | "chore" | "bug"

    The type of Story (feature, bug, chore).

    team_id?: string | null

    The id of the Team to associate with this Story.

    uuid

    workflow_state_id?: number

    The ID of the Workflow State to move the Story to.

    int64

    Settings

    Member Visibility

    On This Page

    Properties