@shortcut/client
    Preparing search index...

    Interface CreateStoryParams

    Request parameters for creating a story.

    interface CreateStoryParams {
        archived?: boolean;
        comments?: CreateStoryCommentParams[];
        completed_at_override?: string;
        created_at?: string;
        custom_fields?: CustomFieldValueParams[];
        deadline?: null | string;
        description?: string;
        epic_id?: null | number;
        estimate?: null | number;
        external_id?: string;
        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;
        requested_by_id?: string;
        source_task_id?: null | number;
        started_at_override?: string;
        story_links?: CreateStoryLinkParams[];
        story_template_id?: null | string;
        story_type?: "feature" | "chore" | "bug";
        sub_tasks?: (CreateSubTaskParams | LinkSubTaskParams)[];
        tasks?: CreateTaskParams[];
        updated_at?: string;
        workflow_state_id?: number;
    }
    Index

    Properties

    archived? comments? completed_at_override? created_at? custom_fields? deadline? description? epic_id? estimate? external_id? external_links? file_ids? follower_ids? group_id? iteration_id? labels? linked_file_ids? move_to? name owner_ids? parent_story_id? project_id? requested_by_id? source_task_id? started_at_override? story_links? story_template_id? story_type? sub_tasks? tasks? updated_at? workflow_state_id?

    Properties

    archived?: boolean

    Controls the story's archived state.

    comments?: CreateStoryCommentParams[]

    An array of comments to add to the story.

    completed_at_override?: string

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

    date-time

    created_at?: string

    The time/date the Story was created.

    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_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.

    1024

    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 name 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 id of the parent story to associate with this story.

    int64

    project_id?: null | number

    The ID of the project the story belongs to.

    int64

    requested_by_id?: string

    The ID of the member that requested the story.

    uuid

    source_task_id?: null | number

    Given this story was converted from a task in another story, this is the original task ID that was converted to this story.

    int64

    started_at_override?: string

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

    date-time

    Optionalstory_links

    story_links?: CreateStoryLinkParams[]

    An array of story links attached to the story.

    Optionalstory_template_id

    story_template_id?: null | string

    The id of the story template used to create this story, if applicable. This is just an association; no content from the story template is inherited by the story simply by setting this field.

    uuid

    Optionalstory_type

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

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

    sub_tasks?: (CreateSubTaskParams | LinkSubTaskParams)[]

    A list of either params to create a new sub-task or link an existing story as a sub-task

    tasks?: CreateTaskParams[]

    An array of tasks connected to the story.

    updated_at?: string

    The time/date the Story was updated.

    date-time

    workflow_state_id?: number

    The ID of the workflow state the story will be in.

    int64

    Settings

    Member Visibility

    On This Page

    Properties