Close Goal

Sample Request Url

https://api.bamboohr.com/api/gateway.php/samplecompany/v1/performance/employees/123/goals/20/close

Sample Request Body

You can add a comment when closing a goal. This is completely optional.

{
    "comment": "This is an optional comment"
}

Sample Response With Milestones

{
    "goal": {
        "id": "20",
        "title": "Lorem ipsum",
        "description": "Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.",
        "percentComplete": 70,
        "alignsWithOptionId": null,
        "sharedWithEmployeeIds": [
            123,
            125
        ],
        "dueDate": "2022-05-31",
        "completionDate": null,
        "status": "closed",
        "milestones": [
            {
                "id": 17,
                "employeeGoalId": 16,
                "title": "Lorem ipsum dolor sit amet",
                "currentValue": 100,
                "startValue": 100,
                "endValue": 50,
                "completedDateTime": null,
                "lastUpdateDateTime": "2022-07-15T15:37:02Z",
                "lastUpdateUserId": 123
            }
         ],
         "actions": {
            "canEditGoalProgressBar": false,
            "canEditGoalMilestoneProgressBar": true
        }
    }
}

Sample Response Without Milestones

{
    "goal": {
        "id": "20",
        "title": "Lorem ipsum",
        "description": "Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.",
        "percentComplete": 75,
        "alignsWithOptionId": null,
        "sharedWithEmployeeIds": [
            123
        ],
        "dueDate": "2021-03-17",
        "completionDate": null,
        "status": "closed"
    }
}