Create Objective Health

Creates a new Health update for the specified Objective.

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

Request

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

status'At Risk' | 'On Track' | 'Off Track' | 'No Health' required

The health status.

textstring

The text body of the Health update.

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.