Update Objective

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

patch/api/v4/{workspace-slug}/objectives/{objective-public-id}

Request

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

Path parameters

workspace-slugstring required

The slug for the Workspace.

objective-public-idinteger required

The ID of the Objective.

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

category_idsinteger[]

An array of IDs of Categories to set on the Objective. Replaces current Categories.

category_ids_addinteger[]

An array of IDs of Categories to add to the Objective.

category_ids_removeinteger[]

An array of IDs of Categories to remove from the Objective.

completed_at_overridestring date-time nullable

A manual override for the time/date the Objective was completed.

descriptionstring

The Objective's description.

namestring

The name of the Objective.

owner_idsstring[]

An array of UUIDs for Members to set as Owners. This will replace the current Owners on the Objective. Sending an empty array will delete all existing Owners.

owner_ids_addstring[]

An array of UUIDs for Members to add as Owners. These will be added to the current Owners on the Objective.

owner_ids_removestring[]

An array of UUIDs for Members to remove as Owners. These will be removed from the current Owners on the Objective.

started_at_overridestring date-time nullable

A manual override for the time/date the Objective was started.

state'in progress' | 'to do' | 'done'

The workflow state of the Objective.

team_idsstring[]

An array of UUIDs for Teams to associate with the Objective. This will replace the current Teams on the Objective. Sending an empty array will remove all existing Teams.

team_ids_addstring[]

An array of UUIDs for Teams to add to the Objective. These will be added to the current Teams on the Objective.

team_ids_removestring[]

An array of UUIDs for Teams to remove from the Objective. These will be removed from the current Teams on the Objective.

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.