Skip to main content
PATCH
Update goal

Authorizations

X-API-Key
string
header
required

Owner-typed API key (ORGANIZATION, PERSON, VALUE_UNIT). Manage org-scoped lifecycle with /v1/public-api-keys; cross-org governance is restricted to /v1/sys/public-api-keys.

Path Parameters

id
string
required
Pattern: [^\s_]\S*

Body

application/json

Patch payload for a goal.

name
string | null
context
string | null
owner
object | null
scope
object | null
targetPeriod
object | null
strategicArea
object | null
tags
string[] | null

Response

Goal updated

id
string
name
string
context
string
status
enum<string>
Available options:
DRAFT,
ACTIVE,
PUBLISHED,
COMPLETED,
REVIEWED,
ABANDONED
archived
boolean