Update Team

Updates the specified Team.

patch/api/v4/{workspace-slug}/teams/{team-public-id}

Request

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

Path parameters

workspace-slugstring required

The slug for the Workspace.

team-public-idstring uuid required

The UUID of the Team.

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 Team is archived.

card_aging_mode'off' | 'gradual' | 'immediate' nullable

The card aging mode for stories in this Team: "gradual" (fixed fade steps at 1, 2, and 4 weeks), "immediate", or "off" (explicitly disabled for this Team). Set to null to inherit the Workspace default (also clears card_aging_threshold_days).

card_aging_threshold_daysinteger nullable

The number of days an in-progress Story can go without activity before it is considered stale. Required when card_aging_mode is "immediate"; not allowed otherwise.

colorstring css-color nullable

The hex color to be displayed with the Team (for example, "#ff0000"). Set to null to clear.

color_key'blue' | 'purple' | 'midnight-blue' | 'orange' | 'yellow-green' | 'brass' | 'gray' | 'fuchsia' | 'yellow' | 'pink' | 'sky-blue' | 'green' | 'red' | 'black' | 'slate' | 'turquoise' nullable

The color key to be displayed with the Team. Set to null to clear.

default_workflow_idinteger nullable

The ID of the default Workflow for Stories created in this Team. Set to null to clear.

descriptionstring

The Team's description.

member_idsstring[]

An array of UUIDs for Members to set as the Team's members. Replaces current members.

member_ids_addstring[]

An array of UUIDs for Members to add to the Team.

member_ids_removestring[]

An array of UUIDs for Members to remove from the Team.

mention_namestring

The Team's mention name.

namestring

The Team's name.

workflow_idsinteger[]

An array of IDs for Workflows to associate with the Team. Replaces current Workflows.

workflow_ids_addinteger[]

An array of IDs for Workflows to add to the Team.

workflow_ids_removeinteger[]

An array of IDs for Workflows to remove from the Team.

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.