Update Epic

Update Epic is used to modify an Epic in your Shortcut Workspace.

patch/api/v4/{workspace-slug}/epics/{epic-public-id}

Request

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

Path parameters

workspace-slugstring required

The slug for the Workspace.

epic-public-idinteger required

The ID of the Epic.

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

archivedboolean

Whether the Epic is archived.

completed_at_overridestring date-time nullable

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 set as Followers. This will replace the current Followers on the Epic. Sending an empty array will delete all existing Followers.

follower_ids_addstring[]

An array of UUIDs for Members to add as Followers. These will be added to the current Followers on the Epic.

follower_ids_removestring[]

An array of UUIDs for Members to remove as Followers. These will be removed from the current Followers on the Epic.

namestring

The Epic's name.

objective_idsinteger[]

An array of IDs for Objectives to which this Epic is related. This will replace the current Objectives on the Epic. Sending an empty array will remove all existing Objectives.

objective_ids_addinteger[]

An array of IDs for Objectives to add to the Epic. These will be added to the current Objectives on the Epic.

objective_ids_removeinteger[]

An array of IDs for Objectives to remove from the Epic. These will be removed from the current Objectives on the Epic.

owner_idsstring[]

An array of UUIDs for Members to set as Owners. This will replace the current Owners on the Epic. Sending an empty array will delete all existing Owners.

owner_ids_addstring[]

An array of UUIDs for Members to add as Owners. These will be added to the current Owners on the Epic.

owner_ids_removestring[]

An array of UUIDs for Members to remove as Owners. These will be removed from the current Owners on the Epic.

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 nullable

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

team_idsstring[]

An array of UUIDs for Teams to associate with the Epic. This will replace the current Teams on the Epic. Sending an empty array will remove all existing Teams.

team_ids_addstring[]

An array of UUIDs for Teams to add to the Epic. These will be added to the current Teams on the Epic.

team_ids_removestring[]

An array of UUIDs for Teams to remove from the Epic. These will be removed from the current Teams on the Epic.

Response

Resource

$schemastring required

The URI for the json-schema for this response.

Changes

No recorded changes to this operation across all 2 revisions of this API.