Create Iteration

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

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

Request

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

end_datestring required

The date this Iteration ends (ISO 8601 date format, e.g. '2024-01-15').

namestring required

The name of this Iteration.

start_datestring required

The date this Iteration begins (ISO 8601 date format, e.g. '2024-01-01').

descriptionstring

The description of the Iteration.

follower_idsstring[]

An array of UUIDs for any Members you want to add as Followers.

team_idsstring[]

An array of UUIDs for any Teams you want to associate with the Iteration.

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.