---
updatedAt: 2025-12-21T10:29:01.000Z
---
Fetch the complete documentation index at: https://apidocs.hibob.com/llms.txt. Use this file to discover all available pages before exploring further.
# Update Goal Status
Updates the status of an existing goal, optionally including a comment.
This endpoint is used to update the status independently from other goal fields such as title, description, or due date.
**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.
# OpenAPI definition
```json
{
"openapi": "3.1.1",
"info": {
"title": "Goals API",
"description": "Public API for managing Goal Types, Goals, and Key Results with clean entity separation.",
"license": {
"name": "Proprietary",
"url": "https://apidocs.hibob.com/docs/api-terms-of-use"
},
"contact": {
"name": "Hi Bob, Inc."
},
"version": "1.0.0"
},
"servers": [
{
"url": "https://api.hibob.com/v1",
"description": "Production"
},
{
"url": "https://api.sandbox.hibob.com/v1",
"description": "Sandbox"
}
],
"x-readme": {
"metrics-enabled": false
},
"tags": [
{
"name": "Goals",
"description": "Operations for managing Goal Types, Goals, and Key Results"
}
],
"paths": {
"/goals/goals/{goalId}/status": {
"patch": {
"operationId": "patch_goals-goals-goalid-status",
"tags": [
"Goals"
],
"summary": "Update Goal Status",
"description": "Updates the status of an existing goal, optionally including a comment.
This endpoint is used to update the status independently from other goal fields such as title, description, or due date.
**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.\n",
"parameters": [
{
"name": "goalId",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
},
"description": "The unique identifier of the goal to update"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateGoalStatusRequest"
},
"example": {
"status": "completed",
"comment": "Goal achieved ahead of schedule"
}
}
}
},
"responses": {
"200": {
"description": "Goal status updated successfully",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"success": {
"type": "boolean",
"example": true
},
"goalId": {
"type": "integer",
"format": "int64",
"example": 123
},
"status": {
"type": "string",
"example": "completed"
}
}
}
}
}
},
"400": {
"description": "Bad request with structured error response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"404": {
"description": "Goal not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"429": {
"description": "Rate limit exceeded",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Basic": []
},
{
"Bearer": []
}
]
}
}
},
"components": {
"schemas": {
"ApiErrorResponse": {
"type": "object",
"required": [
"error",
"message",
"statusCode",
"timestamp"
],
"properties": {
"error": {
"type": "string",
"description": "Error type identifier",
"enum": [
"BAD_REQUEST",
"NOT_FOUND",
"INTERNAL_SERVER_ERROR",
"TOO_MANY_REQUESTS",
"UNAUTHORIZED",
"FORBIDDEN"
],
"example": "BAD_REQUEST"
},
"message": {
"type": "string",
"description": "Human-readable error message",
"example": "Invalid input provided"
},
"statusCode": {
"type": "integer",
"description": "HTTP status code",
"enum": [
400,
401,
403,
404,
429,
500
],
"example": 400
},
"timestamp": {
"type": "string",
"format": "date-time",
"description": "ISO timestamp when the error occurred",
"example": "2025-01-01T12:00:00Z"
}
}
},
"UpdateGoalStatusRequest": {
"type": "object",
"description": "Request schema for updating goal status",
"required": [
"status"
],
"properties": {
"status": {
"type": "string",
"description": "The new status for the goal",
"enum": [
"onTrack",
"offTrack",
"completed",
"incomplete",
"other"
],
"example": "completed"
},
"comment": {
"type": "string",
"description": "Optional comment for the status update",
"example": "Goal achieved ahead of schedule"
}
}
}
},
"securitySchemes": {
"Basic": {
"type": "http",
"scheme": "basic"
},
"Bearer": {
"type": "http",
"scheme": "bearer",
"bearerFormat": "OAuth 2.0",
"description": "OAuth 2.0 authentication using an Access Token is available for registered partners only. Try It! does not support the full HiBob OAuth flow. You can follow these steps to complete the OAuth 2.0 flow in Postman and then paste the token here."
}
}
}
}
```