@shortcut/client
    Preparing search index...

    Interface UpdateStories

    interface UpdateStories {
        after_id?: number;
        archived?: boolean;
        before_id?: number;
        custom_fields_add?: CustomFieldValueParams[];
        custom_fields_remove?: CustomFieldValueParams[];
        deadline?: null | string;
        epic_id?: null | number;
        estimate?: null | number;
        external_links?: string[];
        follower_ids_add?: string[];
        follower_ids_remove?: string[];
        group_id?: null | string;
        iteration_id?: null | number;
        labels_add?: CreateLabelParams[];
        labels_remove?: CreateLabelParams[];
        move_to?: "last" | "first";
        owner_ids_add?: string[];
        owner_ids_remove?: string[];
        project_id?: null | number;
        requested_by_id?: string;
        story_ids: number[];
        story_type?: "feature" | "chore" | "bug";
        workflow_state_id?: number;
    }
    Index

    Properties

    after_id? archived? before_id? custom_fields_add? custom_fields_remove? deadline? epic_id? estimate? external_links? follower_ids_add? follower_ids_remove? group_id? iteration_id? labels_add? labels_remove? move_to? owner_ids_add? owner_ids_remove? project_id? requested_by_id? story_ids story_type? workflow_state_id?

    Properties

    after_id?: number

    The ID of the story that the stories are to be moved below.

    int64

    archived?: boolean

    If the Stories should be archived or not.

    before_id?: number

    The ID of the story that the stories are to be moved before.

    int64

    custom_fields_add?: CustomFieldValueParams[]

    A map specifying a CustomField ID and CustomFieldEnumValue ID that represents an assertion of some value for a CustomField.

    custom_fields_remove?: CustomFieldValueParams[]

    A map specifying a CustomField ID and CustomFieldEnumValue ID that represents an assertion of some value for a CustomField.

    deadline?: null | string

    The due date of the story.

    date-time

    epic_id?: null | number

    The ID of the epic the story belongs to.

    int64

    estimate?: null | number

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

    int64

    external_links?: string[]

    An array of External Links associated with this story.

    follower_ids_add?: string[]

    The UUIDs of the new followers to be added.

    true

    follower_ids_remove?: string[]

    The UUIDs of the followers to be removed.

    true

    group_id?: null | string

    The Id of the Group the Stories should belong to.

    uuid

    iteration_id?: null | number

    The ID of the iteration the story belongs to.

    int64

    labels_add?: CreateLabelParams[]

    An array of labels to be added.

    labels_remove?: CreateLabelParams[]

    An array of labels to be removed.

    move_to?: "last" | "first"

    One of "first" or "last". This can be used to move the given story to the first or last position in the workflow state.

    owner_ids_add?: string[]

    The UUIDs of the new owners to be added.

    true

    owner_ids_remove?: string[]

    The UUIDs of the owners to be removed.

    true

    project_id?: null | number

    The ID of the Project the Stories should belong to.

    int64

    requested_by_id?: string

    The ID of the member that requested the story.

    uuid

    story_ids

    story_ids: number[]

    The Ids of the Stories you wish to update.

    true

    Optionalstory_type

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

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

    workflow_state_id?: number

    The ID of the workflow state to put the stories in.

    int64

    Settings

    Member Visibility

    On This Page

    Properties