DocumentationAPI Reference
API Reference
Start typing to search…

Update Goal (v1.1)

put
https://{companyDomain}.bamboohr.com/api/v1_1/performance/employees//goals/

Update a goal. This version supports updating the milestones contained within a goal. Note: Compared to "Update Goal (v1)", this version adds milestone updates.

Path Params
integer
required

employeeId is the employee ID with whom the goal is associated.

integer
required

goalId is the goal ID for the specified employee.

Body Params

Required fields: title, sharedWithEmployeeIds, dueDate. Omitted optional fields overwrite existing values using the endpoint's default behavior; see individual field descriptions for details.

string
required

The title of the goal

string

A detailed description of the goal

date
required

The due date for the goal in YYYY-MM-DD format

integer
0 to 100

The percentage of completion for the goal (0-100). Required when milestonesEnabled is not true.

date | null

The date when the goal was completed in YYYY-MM-DD format. Required when percentComplete is 100.

sharedWithEmployeeIds
array of integers
required

List of employee IDs with whom the goal is shared. Must include the employee ID of the goal owner.

sharedWithEmployeeIds*
integer | null

ID of the option this goal aligns with

boolean

Flag indicating whether milestones are enabled for this goal

deletedMilestoneIds
array of integers

List of milestone IDs to be deleted from the goal

deletedMilestoneIds
milestones
array of objects

List of milestones to add to this goal

milestones
Responses

Updated 22 days ago

Language
Credentials
:
URL
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 22 days ago