Skip to main content
DELETE
Archive an objective
Archives an objective by setting its status to CANCELLED, as the Console does. The objective and its key results are kept; set another status with Update objective. Send { "id": "..." }; an unknown or malformed id is 404 resource_missing; omitting id is 400 bad_request. 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. Archiving an archived objective succeeds again. A same-key retry within 24 hours returns the recorded result while the caller still holds both permissions at the deployment root.

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

Response

Archive an objective

data
object
required
meta
object
required