Create Team

Creates a new Team in the Workspace.

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

Request

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

mention_namestring required

The Team's mention name.

namestring required

The Team's name.

workflow_idsinteger[] required

An array of IDs for Workflows to associate with the Team. At least one Workflow is required.

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.

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

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

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

The color key to be displayed with the Team.

default_workflow_idinteger

The ID of the default Workflow for Stories created in this Team.

descriptionstring

The Team's description.

member_idsstring[]

An array of UUIDs for Members to add to 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.