DocumentationAPI Reference
API Reference

Update Goal Comment

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

Updates the text of an existing goal comment. The comment must belong to the specified goal, and the goal must belong to the specified employee. Returns the updated comment object. If the user does not provide a comment ID, first call list-goal-comments and select a single editable comment (canEdit is true) matching the user's description. If multiple comments match or none are editable, do not update; ask for clarification.

OAuth Scopes: goal.write

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

The internal employee ID of the employee the goal is associated with.

string
required
^\d+$

goalId is the goal ID for the specified employee.

string
required

commentId is the comment ID for the specified goal.

Body Params
string
required

The updated text content of the comment.

Responses

Updated 3 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 3 months ago