Skip to content
HeyX API

List Customer Comment History

Required scope: customer_comment:read

Use this endpoint to read the saved edit history of one customer comment. Each entry is a prior body together with the time it was superseded by a newer edit, returned oldest first. The list is empty when the comment has never been edited.

Find comment IDs with List Customer Comments; a comment’s isEdited flag indicates whether history is available.

Generated Reference
POST /public-api/publicapi.v1.Customer/ListCustomerCommentHistory

Lists the saved edit history of a single customer comment. Each entry is a prior body with the time it was superseded. Read-only.

Request ListCustomerCommentHistoryRequest
Response ListCustomerCommentHistoryResponse

ListCustomerCommentHistoryRequest

Field Type Description
comment_id string Comment whose edit history is returned.

ListCustomerCommentHistoryResponse

Field Type Description
entries repeated CustomerCommentHistoryEntry Prior revisions of the comment, oldest first. Empty when the comment has never been edited.

Related Types

CustomerCommentHistoryEntry

Field Type Description
id string Stable identifier of this history entry.
body string The comment body as it was before this revision was superseded.
edited_at int64 Unix timestamp in seconds when this body was replaced by a newer edit.

Request

Section titled “Request”
{
  "commentId": "a2ec8aef-691a-4e9d-b4fd-52e255883c6c"
}

Example

Section titled “Example”
Terminal window
curl https://portal.heyx.app/public-api/publicapi.v1.Customer/ListCustomerCommentHistory \
  -H "Authorization: Bearer hx_sk_..." \
  -H "Content-Type: application/json" \
  -d '{"commentId": "a2ec8aef-691a-4e9d-b4fd-52e255883c6c"}'

Response

Section titled “Response”
{
  "entries": [
    {
      "id": "d1f2a3b4-5c6d-4e7f-8a9b-0c1d2e3f4a5b",
      "body": "Imported note",
      "editedAt": 1735689600
    }
  ]
}
HeyX API