Update Iteration

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

patch/api/v4/{workspace-slug}/iterations/{iteration-public-id}

Request

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

Path parameters

workspace-slugstring required

The slug for the Workspace.

iteration-public-idinteger required

The unique ID of the Iteration.

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

descriptionstring

The description of the Iteration.

end_datestring

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

follower_idsstring[]

An array of UUIDs for any Members you want to set as Followers, replacing existing Followers.

follower_ids_addstring[]

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

follower_ids_removestring[]

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

namestring

The name of this Iteration.

start_datestring

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

team_idsstring[]

An array of UUIDs for any Teams you want to set on the Iteration, replacing existing Teams.

team_ids_addstring[]

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

team_ids_removestring[]

An array of UUIDs for any Teams you want to remove from 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.