Skip to main content
PATCH
Update an objective
Changes an objective’s title, description, ownerKind and ownerRefId (always together; company or orgUnit), status (DRAFT, ACTIVE, COMPLETE or CANCELLED) or targetDate. Send id plus at least one field; omitted fields are unchanged. An unknown or malformed id is 404 resource_missing; omitting id is 400 bad_request. A worker-owned objective keeps ownerRefId: null in the response. The credential needs both the objectives:read and objectives:manage scopes, and objectives:read and objectives:manage granted at the deployment root; otherwise 403 permission_denied names the missing permission. The body is strict: unknown fields are 400 bad_request. Success is 200 with the post-write Objective. A same-key retry within 24 hours returns the recorded result while the caller still holds both permissions at the deployment root; otherwise 409 idempotency_result_unavailable. Reconcile an unknown outcome with Get objective.

Authorizations

Authorization
string
header
required

An External App: the JWT it obtains from POST /oauth/token with OAuth2 client_credentials. Pass as Authorization: Bearer <jwt>. An app's static companion key also authenticates as the app, but is deprecated and is not protected by Idempotency-Key.

Headers

Idempotency-Key
string

Optional logical intent key. A same-key retry within 24 hours returns the recorded result without writing again.

Required string length: 1 - 255

Path Parameters

objectiveId
string
required

The objective ID, as the objective reads return it.

Minimum string length: 1

Body

application/json

The fields to change; omitted fields are unchanged. At least one field besides id is required, and ownerKind and ownerRefId are given together. Unknown fields are refused.

title
string

Stored exactly as sent; at most 200 characters and not blank.

Maximum string length: 200
description
string

At most 4,000 characters.

Maximum string length: 4000
ownerKind
enum<string>
required if ownerRefId is set

Who owns the objective. A machine never names a worker owner.

Available options:
company,
orgUnit
ownerRefId
string
required if ownerKind is set

The owning company or org unit identifier, recorded as sent.

Required string length: 1 - 200
status
enum<string>
Available options:
DRAFT,
ACTIVE,
COMPLETE,
CANCELLED
targetDate
number

When the objective is due, epoch milliseconds.

Response

Update an objective

data
object
required
meta
object
required