Update Goal, V1.1

Update a goal. Version 1.1 allows the updating of the milestones contained within the goal, unlike Version 1.

Sample URL

https://api.bamboohr.com/api/gateway.php/samplecompany/v1_1/performance/employees/123/goals/10

Sample Request Body Without Milestones

{
    "dueDate": "2024-03-17",
    "sharedWithEmployeeIds": [
        "123"
    ],
    "title": "Lorem ipsum dolor sit amet",
    "description": "Sit amet consectetur adipiscing elit duis tristique sollicitudin.",
    "percentComplete": 75
}

Sample Request Body With Milestones

{
    "dueDate": "2024-03-17",
    "sharedWithEmployeeIds": [
        "123"
    ],
    "title": "Lorem ipsum dolor sit amet",
    "description": "Sit amet consectetur adipiscing elit duis tristique sollicitudin.",
    "milestonesEnabled": true,
    "deletedMilestoneIds": [3],
    "milestones": [
        {
            "title": "milestone a",
            "startValue": 0,
            "endValue": 15
        },
        {
            "title": "milestone b",
            "startValue": 10,
            "endValue": 5
        }
    ]
}

Sample Response With Milestones

{
    "goal": {
        "id": "10",
        "title": "Lorem ipsum dolor sit amet",
        "description": "Sit amet consectetur adipiscing elit duis tristique sollicitudin.",
        "percentComplete": 0,
        "alignsWithOptionId": "0",
        "sharedWithEmployeeIds": [
            123
        ],
        "dueDate": "2024-03-17",
        "completionDate": null,
        "status": "in_progress",
        "milestones": [
            {
                "id": 17,
                "employeeGoalId": 10,
                "title": "milestone a",
                "currentValue": 0,
                "startValue": 0,
                "endValue": 15,
                "completedDateTime": null,
                "lastUpdateDateTime": "2022-07-15T15:37:02Z",
                "lastUpdateUserId": 123
            },
            {
                "id": 18,
                "employeeGoalId": 10,
                "title": "milestone b",
                "currentValue": 10,
                "startValue": 10,
                "endValue": 5,
                "completedDateTime": null,
                "lastUpdateDateTime": "2022-07-15T15:37:02Z",
                "lastUpdateUserId": 123
            }
        ],
        "actions": {
            "canEditGoalProgressBar": false,
            "canEditGoalMilestoneProgressBar": true
        }
    }
}

Sample Response Without Milestones

{
    "goal": {
        "id": "10",
        "title": "Lorem ipsum dolor sit amet",
        "description": "Sit amet consectetur adipiscing elit duis tristique sollicitudin.",
        "percentComplete": 75,
        "alignsWithOptionId": null,
        "sharedWithEmployeeIds": [
            123
        ],
        "dueDate": "2024-03-17",
        "completionDate": null,
        "status": "in-progress"
    }
}
Language
Authentication
Basic
base64
:
Click Try It! to start a request and see the response here!