@shortcut/client
    Preparing search index...

    Interface UpdateStory

    interface UpdateStory {
        after_id?: number;
        archived?: boolean;
        before_id?: number;
        branch_ids?: number[];
        commit_ids?: number[];
        completed_at_override?: null | string;
        custom_fields?: CustomFieldValueParams[];
        deadline?: null | string;
        description?: string;
        epic_id?: null | number;
        estimate?: null | number;
        external_links?: string[];
        file_ids?: number[];
        follower_ids?: string[];
        group_id?: null | string;
        iteration_id?: null | number;
        labels?: CreateLabelParams[];
        linked_file_ids?: number[];
        move_to?: "last" | "first";
        name?: string;
        owner_ids?: string[];
        parent_story_id?: null | number;
        project_id?: null | number;
        pull_request_ids?: number[];
        requested_by_id?: string;
        started_at_override?: null | string;
        story_type?: "feature" | "chore" | "bug";
        workflow_state_id?: number;
    }
    Index

    Properties

    after_id? archived? before_id? branch_ids? commit_ids? completed_at_override? custom_fields? deadline? description? epic_id? estimate? external_links? file_ids? follower_ids? group_id? iteration_id? labels? linked_file_ids? move_to? name? owner_ids? parent_story_id? project_id? pull_request_ids? requested_by_id? started_at_override? story_type? workflow_state_id?

    Properties

    after_id?: number

    The ID of the story we want to move this story after.

    int64

    archived?: boolean

    True if the story is archived, otherwise false.

    before_id?: number

    The ID of the story we want to move this story before.

    int64

    branch_ids?: number[]

    An array of IDs of Branches attached to the story.

    true

    commit_ids?: number[]

    An array of IDs of Commits attached to the story.

    true

    completed_at_override?: null | string

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

    date-time

    custom_fields?: 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

    description?: string

    The description of the story.

    100000

    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.

    file_ids?: number[]

    An array of IDs of files attached to the story.

    true

    follower_ids?: string[]

    An array of UUIDs of the followers of this story.

    true

    group_id?: null | string

    The ID of the group to associate with this story

    uuid

    iteration_id?: null | number

    The ID of the iteration the story belongs to.

    int64

    labels?: CreateLabelParams[]

    An array of labels attached to the story.

    linked_file_ids?: number[]

    An array of IDs of linked files attached to the story.

    true

    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.

    name?: string

    The title of the story.

    1

    512

    owner_ids?: string[]

    An array of UUIDs of the owners of this story.

    true

    Optionalparent_story_id

    parent_story_id?: null | number

    The parent story id. If you want to unset this value set parent_story_id to null.

    int64

    project_id?: null | number

    The ID of the project the story belongs to.

    int64

    pull_request_ids?: number[]

    An array of IDs of Pull/Merge Requests attached to the story.

    true

    requested_by_id?: string

    The ID of the member that requested the story.

    uuid

    started_at_override?: null | string

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

    date-time

    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 story in.

    int64

    Settings

    Member Visibility

    On This Page

    Properties