Skip to main content
POST
Create 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.

Body

application/json

Create payload for a goal.

name
string
required
Maximum string length: 300
Pattern: \S
context
string
required
Maximum string length: 500
Pattern: \S
owner
object
required
scope
object
required
targetPeriod
object
required
strategicArea
object
tags
string[]
Maximum array length: 10
template
object
keyResultTemplates
object[]
Maximum array length: 10

Response

Goal created

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