Skip to content
First requestVisit website ↗
Navigation

Save an internal comment on a contact

Requires a signed-in session (Authorization Bearer) and current membership of the workspace in X-Workspace-Id. Any member may comment on any contact in that workspace. The server builds the row: only body, contact, msg_type (comment or note), user_name and a client UUID are taken from the request; direction, internal flag and time are set by the server, and the verified author is stored in metadata.author_user_id (user_id stays empty so reports do not count comments as agent messages). A client id is used once: re-sending it within 24 hours by the same author for the same contact returns the first row; any other reuse, in any workspace, is 409. Mentioned users who are not current members are dropped.

POST
https://api.channelautomation.com/api/livechat2/save-comment

Authorization

  • bearerAuth
    bearerAuth
    required

Header parameters

  • X-Workspace-Id
    string
    required

Request body JSON required

  • message
    object
    required
    • contact_id
      string
      required
      format: uuid
    • workspace_id
      string
      required
    • body
      string
      required
      maxLength: 10000
    • id
      optional
      string
      format: uuid
    • msg_type
      optional
      comment
      or
      note
    • user_name
      optional
      string
      maxLength: 200
  • mentionedUsers
    optional
    array of
    string
    format: uuid

Returns

200

{ data: [row], mentionsRecorded } — mentionsRecorded is false only when mentions could not be recorded, so no mention emails will send. Re-sending the same id returns the first row, and records its mentions if none were recorded yet.

400

Missing or invalid fields

401

No valid signed-in session

403

Not a member of the workspace

404

The contact is not in this workspace

409

The id is already used (by another comment

503

Identity or membership verification unavailable

Type to search…

↑↓ navigate↵ selectEsc close