v1

latestOpenAPI 3.1.1Proprietary2026-07-26184406877.9 KB
Goals

Update Key Results Progress

Update the progress (check-in) of one or more key results for a specific goal without changing the goal status. <br><br>Note: This endpoint behaves like the check-in mechanism in Bob, however, it maintains the current goal status, updating only the key result progress. To update the goal status, use the Update Goal Status endpoint. <br><br>This endpoint supports optional audit fields at both levels: goal-level comment and key result-level notes. These parameters only affect check-in activity log for auditing purposes. They are not part of the Goal or Key Result entities, and are not returned by search/metadata endpoints.

patch/goals/goals/{goalId}/key-results/progress

Path parameters

goalIdinteger required

The unique identifier of the goal containing the key results

Request body

commentstring

Optional goal-level comment for this check-in (progress update). Used for auditing only and captured in the check-in activity log. Does not update the Key Result entity, and is not returned by search/metadata endpoints.

Example request

{
  "keyResults": [
    {
      "notes": "Completed milestone ahead of schedule"
    }
  ],
  "comment": "Weekly progress update"
}

Response

Key results progress updated successfully

successboolean

Whether the update was successful

goalIdinteger

The ID of the goal containing the key results