DocumentationAPI Reference
API Reference
Start typing to search…

Update Goal (v1)

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

Deprecated. Use "Update Goal (v1.1)" instead. Update a goal. This version will not update a goal to contain milestones, that functionality is added in version 1.1.

Path Params
string
required

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

string
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

[Required] The goal title.

string

[Optional] The goal description. If omitted, the existing value will be overwritten with an empty string.

integer

[Optional] The goal completion percentage (0-100). If omitted, the existing value will be overwritten with 0.

string | null

[Optional] The option ID that aligns with this goal. If omitted, the existing value will be overwritten with null.

sharedWithEmployeeIds
array of integers
required

[Required] Employee IDs of employees with whom the goal is shared. All goal owners are considered "shared with". This must include the employee for whom the goal is created.

sharedWithEmployeeIds*
date
required

[Required] The goal due date in YYYY-MM-DD format.

date | null

[Optional] The date the goal was completed, in YYYY-MM-DD format. Required when percentComplete is 100. If omitted, the existing value will be overwritten with null.

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