Sign in
objectives

Archive an OKR

Takes an OKR out of the working set: it stops appearing in lists, stops contributing to parent rollups, and stops generating check-in reminders. It keeps its place in the hierarchy and its full history, and is reversible through unarchive. Optionally cascades to single-aligned children -- a child aligned to more than one parent is never taken.

post/okrs/objectives/archive

Request body

uuidstring required

OKR UUID or human readable short ID (e.g., OBJ-001, KR-001, INIT-001)

archive_hierarchyboolean

When true, archive the whole single-aligned subtree beneath this OKR.

including_immediate_objectivesboolean

When true, also archive single-aligned immediate child Objectives. Ignored when archive_hierarchy is true.

including_immediate_key_resultsboolean

When true, also archive single-aligned immediate child Key Results. Ignored when archive_hierarchy is true.

including_immediate_initiativesboolean

When true, also archive single-aligned immediate child Initiatives. Ignored when archive_hierarchy is true.

Changes

Changed in 1 of the 18 revisions of this API.1