DocumentationAPI Reference
API Reference

Create Goal

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

Create a new goal for an employee. To create a simple goal without milestones, omit the milestones field; the goal's progress can then be changed with update-goal-progress. To create a milestone-based goal, provide milestones as a non-empty array of { "title": string } objects; the goal's percent complete is then derived from milestone completion and should be changed via update-goal-milestone-progress. Sending milestones: null is treated as omitted (creates a simple goal).

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

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

Body Params
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

Initial percentage of completion for a simple goal (0-100). Defaults to 0 if omitted. Ignored when milestones is provided; milestone-based goals derive percent complete from milestone completion and should be updated via update-goal-milestone-progress.

The date when the goal was completed in YYYY-MM-DD format. Only valid when percentComplete is 100; providing this field with any other percentComplete value will result in an error.

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*

ID of the option this goal aligns with

milestones
array of objects

Optional. Provide a non-empty array of milestone objects to create a milestone-based goal. Omit this field (or send null) to create a simple goal.

milestones
Responses

Updated 2 months ago

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

Updated 2 months ago