v1

latestOpenAPI 3.0.32026-07-268955212.1 KB

journal-entries

Update a comment on a journal entry

Updates a comment on a journal entry. Only comments created by the same integration can be updated.

Comments are plain text only. Rich text, markdown, and HTML are not supported.

Scope: journal-entries:write

put/companies/{companyId}/journal-entries/{journalEntryId}/comments/{commentId}

Request body

contentstring required

The plain text content of the comment. Rich text, markdown, and HTML are not supported.

Example request

{
  "content": "Synced from external system. Invoice reference: INV-2024-001."
}

Response

Comment updated

idstring uuid

Unique identifier of the comment

contentstring

The plain text content of the comment

authorNamestring

Display name of the comment author (integration name or user name)

createdDatetimestring date-time

When the comment was created (UTC)

updatedDatetimestring date-time

When the comment was last updated (UTC)

Example response

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "content": "Synced from external system. Invoice reference: INV-2024-001.",
  "authorName": "My Integration App",
  "createdDatetime": "2024-10-15T08:30:00Z",
  "updatedDatetime": "2024-10-15T08:30:00Z"
}