---
updatedAt: 2025-12-25T07:15:59.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 Key Results Progress
Update the progress (check-in) of one or more key results for a specific goal without changing the goal status.
**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.
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.
# 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}/key-results/progress": {
"patch": {
"operationId": "patch_goals-goals-goalid-key-results-progress",
"tags": [
"Goals"
],
"summary": "Update Key Results Progress",
"description": "Update the progress (check-in) of one or more key results for a specific goal without changing the goal status.\n
**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.\n
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.\n",
"parameters": [
{
"name": "goalId",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
},
"description": "The unique identifier of the goal containing the key results"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateKeyResultsProgressRequest"
},
"example": {
"keyResults": [
{
"keyResultId": 123,
"currentValue": 75,
"notes": "Completed milestone ahead of schedule"
},
{
"keyResultId": 124,
"currentValue": true
}
],
"comment": "Weekly progress update - great momentum on both metrics"
}
}
}
},
"responses": {
"200": {
"description": "Key results progress updated successfully",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"success": {
"type": "boolean",
"description": "Whether the update was successful"
},
"goalId": {
"type": "integer",
"format": "int64",
"description": "The ID of the goal containing the key results"
},
"updatedKeyResults": {
"type": "array",
"items": {
"type": "object",
"properties": {
"keyResultId": {
"type": "integer",
"format": "int64"
},
"currentValue": {
"oneOf": [
{
"type": "number"
},
{
"type": "boolean"
}
]
}
}
},
"description": "Array of updated key results with their new values"
}
}
},
"example": {
"success": true,
"goalId": 456,
"updatedKeyResults": [
{
"keyResultId": 123,
"currentValue": 75
},
{
"keyResultId": 124,
"currentValue": true
}
]
}
}
}
},
"400": {
"description": "Bad request with structured error response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"404": {
"description": "Goal or key result not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"error": "NOT_FOUND",
"message": "Goal not found",
"statusCode": 404,
"timestamp": "2025-01-01T12:00:00Z"
}
}
}
},
"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"
}
}
},
"UpdateKeyResultsProgressRequest": {
"type": "object",
"description": "Request schema for updating the progress of key results",
"properties": {
"keyResults": {
"type": "array",
"description": "List of key results to update",
"items": {
"type": "object",
"properties": {
"keyResultId": {
"type": "integer",
"format": "int64",
"description": "The ID of the key result to update"
},
"currentValue": {
"description": "The new current value - accepts typed values (number for numeric/currency/percentage, boolean for boolean) or strings\n",
"oneOf": [
{
"type": "number",
"description": "For numeric, currency, and percentage measures"
},
{
"type": "boolean",
"description": "For boolean measures"
},
{
"type": "string",
"description": "String representation (backward compatibility)"
}
]
},
"notes": {
"type": "string",
"description": "Optional key result-level note 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.\n",
"example": "Completed milestone ahead of schedule"
}
}
}
},
"comment": {
"type": "string",
"description": "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.\n",
"example": "Weekly progress update"
}
}
}
},
"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."
}
}
}
}
```