Create Objective

Create Objective is used to create a new Objective in your Shortcut Workspace.

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

Request

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

namestring required

The name of the Objective.

category_idsinteger[]

An array of IDs of Categories attached to the Objective.

completed_at_overridestring date-time

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

descriptionstring

The Objective's description.

owner_idsstring[]

An array of UUIDs for Members to add as Owners.

started_at_overridestring date-time

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.

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.