Create Epic

Create Epic is used to create a new Epic in your Shortcut Workspace.

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

Request

  • Base URL: https://api.app.shortcut.com
  • URL: https://api.app.shortcut.com/api/v4/{workspace-slug}/epics
  • 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 Epic's name.

completed_at_overridestring date-time

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

deadlinestring date-time nullable

The Epic's deadline.

descriptionstring

The Epic's description.

epic_state_idinteger

The ID of the Epic State.

external_idstring

An external ID for the Epic.

follower_idsstring[]

An array of UUIDs for Members to add as Followers.

objective_idsinteger[]

An array of IDs for Objectives to which this Epic is related.

owner_idsstring[]

An array of UUIDs for Members to add as Owners.

planned_start_datestring date-time nullable

The Epic's planned start date.

requested_by_idstring uuid

The UUID of the Member that requested the Epic.

started_at_overridestring date-time

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

team_idsstring[]

An array of UUIDs for Teams to associate with the Epic.

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.