Update Goal

Update goal details including title, description, status, and target period.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
Body Params

Payload for replacing the editable details of an existing goal.

string
required

The title of the goal.

string | null
deprecated

Deprecated by 'description_json'. Sending this field will
overwrite any rich-text document currently stored on the
goal with a minimal ProseMirror projection of the plain
text, losing formatting, images, and (future) mentions.

A plain-text description of the goal.

string | null

Rich-text description as a ProseMirror JSON document.
Preferred over the deprecated plain-text description
field. When omitted the server preserves the existing
document so partial updates do not blank rich content.

string
required

The status of the goal.

  • Available values: OnTrack, AtRisk, OffTrack, OnHold, Complete.
target_period
required

The target period for achieving the goal.

Headers
string
enum
Defaults to application/json

Generated from available request content types

Allowed:
Responses
204

No Content

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json