Create Story

Create Story is used to add a new Story to your Shortcut Workspace.

post/api/v4/{workspace-slug}/stories

Request

  • Base URL: https://api.app.shortcut.com
  • URL: https://api.app.shortcut.com/api/v4/{workspace-slug}/stories
  • Auth: HTTP bearer

Path parameters

workspace-slugstring required

The slug for the Workspace.

Query parameters

fieldsstring

Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.

Request body

namestring required

The name of the Story.

workflow_state_idinteger required

The ID of the Workflow State the Story will be in.

archivedboolean

Controls the Story's archived state.

deadlinestring date-time nullable

The due date of the Story.

descriptionstring

The description of the story.

epic_idinteger nullable

The ID of the Epic the Story belongs to.

estimateinteger nullable

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

external_idstring

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.

external_linksstring[]

An array of External Links associated with the Story.

file_idsinteger[]

An array of IDs of Files attached to the Story.

follower_idsstring[]

An array of UUIDs of the Members that follow this Story.

iteration_idinteger nullable

The ID of the Iteration the Story belongs to.

label_idsinteger[]

Labels to attach to the Story.

linked_file_idsinteger[]

An array of IDs of Linked Files attached to the Story.

owner_idsstring[]

An array of UUIDs of the Members that own this Story.

parent_story_idinteger nullable

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.

project_idinteger nullable

The ID of the Project the Story belongs to.

requester_idstring uuid

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

story_type'feature' | 'chore' | 'bug'

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

team_idstring uuid nullable

The id of the Team to associate with this Story.

Response

Resource

$schemastring required

The URI for the json-schema for this response.

Changes

No recorded changes to this operation across all 1 revision of this API.