Skip to main content
POST
cURL

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
title
string
required
Minimum string length: 1
description
string
cadence
string
department
string
keyResults
object[]
Maximum array length: 50
kind
enum<string>
default:goal
Available options:
goal,
okr,
milestone
parentId
string<uuid>
ownerId
string<uuid>
status
enum<string>
default:not_started
Available options:
not_started,
on_track,
at_risk,
behind,
achieved,
closed
progress
number | null
default:0
Required range: 0 <= x <= 100
targetType
enum<string>
Available options:
number,
percent,
currency,
boolean,
tasks,
kpi
targetUnit
string | null
Maximum string length: 8
startValue
number | null
targetValue
number | null
currentValue
number | null
kpiMetricType
enum<string> | null
Available options:
goal_attainment,
task_completion,
utilization,
engagement,
null
atRiskThreshold
number | null
Required range: 0 <= x <= 100
behindThreshold
number | null
Required range: 0 <= x <= 100
dueDate
string
period
string

Response

201 - application/json

Success

data
object
required