@shortcut/client
    Preparing search index...

    Interface CreateStoryParams

    interface CreateStoryParams {
        archived?: boolean;
        checklist_items?: CreateStoryChecklistItemParams[];
        custom_field_values?: CreateCustomFieldValueParams[];
        deadline?: string | null;
        description?: string;
        epic_id?: number | null;
        estimate?: number | null;
        external_id?: string;
        external_links?: string[];
        file_ids?: number[];
        follower_ids?: string[];
        iteration_id?: number | null;
        label_ids?: number[];
        linked_file_ids?: number[];
        name: string;
        owner_ids?: string[];
        parent_story_id?: number | null;
        project_id?: number | null;
        requester_id?: string;
        set_position?: StorySetPosition;
        story_links?: CreateNestedStoryLinkParams[];
        story_type?: "feature" | "chore" | "bug";
        team_id?: string | null;
        workflow_state_id: number;
    }
    Index

    Properties

    archived? checklist_items? custom_field_values? deadline? description? epic_id? estimate? external_id? external_links? file_ids? follower_ids? iteration_id? label_ids? linked_file_ids? name owner_ids? parent_story_id? project_id? requester_id? set_position? story_links? story_type? team_id? workflow_state_id

    Properties

    archived?: boolean

    Controls the Story's archived state.

    checklist_items?: CreateStoryChecklistItemParams[]

    An array of Checklist Items connected to the Story.

    custom_field_values?: CreateCustomFieldValueParams[]

    An array of objects specifying a Custom Field value ID and CustomFieldEnumValue ID that represents an assertion of some value for a Custom Field value.

    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.

    true

    file_ids?: number[]

    An array of IDs of Files attached to the Story.

    true

    follower_ids?: string[]

    An array of UUIDs of the Members that follow this 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.

    true

    linked_file_ids?: number[]

    An array of IDs of Linked Files attached to 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.

    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_links

    story_links?: CreateNestedStoryLinkParams[]

    An array of Story links attached to the 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 the Story will be in.

    int64

    Settings

    Member Visibility

    On This Page

    Properties