v1

latestOpenAPI 3.1.02026-07-26294215839.4 KB

Goals

Public API

Update Goal Comment

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

put/api/v1/performance/employees/{employeeId}/goals/{goalId}/comments/{commentId}

Path parameters

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.

commentIdstring required

commentId is the comment ID for the specified goal.

Request body

textstring required

The updated text content of the comment.

Response

A successful response indicates that all the requested changes were made. The content of the response will be the goal comment response object for the specified commentId.

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.

Example response

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