Update Label

Update Label allows you to modify a Label in your Shortcut Workspace.

patch/api/v4/{workspace-slug}/labels/{label-public-id}

Request

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

Path parameters

workspace-slugstring required

The slug for the Workspace.

label-public-idinteger required

The ID of the Label.

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

A true/false boolean indicating if the Label has been archived.

colorstring css-color nullable

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

descriptionstring

The description of the Label.

namestring

The name of the Label.

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.