Create Goal Comment

Creates a new comment on a goal. The goal must belong to the specified employee. Returns the newly created comment object including its assigned ID.

OAuth Scopes: goal.write

post/api/v1/performance/employees/{employeeId}/goals/{goalId}/comments

Request

Base URL
https://companySubDomain.bamboohr.com
Auth
- HTTP basic
- or OAuth 2
  Authorization code/authorize.php
  Token URL/token.php
  Scopesgoal.write
TypeScript
https://skmtc.dev/bamboohr/apis/bamboohr-api/docs/api/v1/performance/employees/:employeeId/goals/:goalId/comments/post.ts
A function with typed inputs. Its response is checked against the schema.

employeeIdstring required

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

goalIdstring required

goalId is the goal ID for the specified employee.

textstring required

The text content of the comment.

A goal comment object with the new goal comment ID.

idstring

The comment ID.

authorUserIdinteger

The user ID of the comment author.

createdAtstring

ISO 8601 UTC timestamp when the comment was created.

textstring

The text content of the comment.

canEditboolean

Whether the authenticated caller can edit this comment.

canDeleteboolean

Whether the authenticated caller can delete this comment.

{
  "createdAt": "2025-04-10T15:36:38Z"
}

No recorded changes to this operation across all 2 revisions of this API.