v1

latestOpenAPI 3.1.1Proprietary2026-07-26184406877.9 KB

Goals

Update Goal Status

Updates the status of an existing goal, optionally including a comment. <br>This endpoint is used to update the status independently from other goal fields such as title, description, or due date. <br><br>Note: In Bob, status changes are performed through a dedicated workflow (e.g., goal check-ins), which is why this action is exposed via a separate endpoint.

patch/goals/goals/{goalId}/status

Path parameters

goalIdinteger required

The unique identifier of the goal to update

Request body

status'onTrack' | 'offTrack' | 'completed' | 'incomplete' | 'other' required

The new status for the goal

commentstring

Optional comment for the status update

Example request

{
  "status": "completed",
  "comment": "Goal achieved ahead of schedule"
}

Response

Goal status updated successfully

successboolean

goalIdinteger

statusstring

Example response

{
  "success": true,
  "goalId": 123,
  "status": "completed"
}