Skip to content

Message

A message in a conversation. Either body or attachments (or both) must be provided. A message cannot be empty - it must contain either text content or at least one attachment.

idstringrequired

Unique identifier for the message in your system

Example:"msg_001"
conversation_idstringrequired

ID of the parent conversation

Example:"conv_456"
message_typestring(MessageType)required

Type of message

Value:"comment"
Example:"comment"
bodystring or null(HtmlMessageBody)

Message content in HTML format.

Supported HTML tags are:

  • Paragraphs <p>
  • Heading 1, Heading 2 <h1> <h2> (note h3 to h6 appears as a h2)
  • Bold <b>
  • Italic <i>
  • Links <a>
  • Images <img> (can be linked)
  • Line breaks <br>
  • Code blocks <code>
  • Unordered lists <ul>
  • Ordered lists <ol>
Example:"<p>Hi! I'd like to know more about your pricing plans.</p>"
authorEndUser (object) or Agent (object)required
One of:

End user having a conversation with Fin or with an agent.

visibilitystring(MessageVisibility)required

Who can see the message:

  • public - Visible to end-users (appears in Fin Messenger)
  • private - Only visible to agents (internal notes)
Enum:"public""private"
Example:"public"
created_atstring, (date-time)required

When the message was created (ISO 8601 UTC)

Example:"2025-10-27T14:35:00.000Z"
attachmentsArray of objects(Attachment)

Files attached to the message

{ "id": "msg_001", "conversation_id": "conv_456", "message_type": "comment", "body": "string", "author": { "id": "user_123456", "user_type": "end_user", "name": "Jane Doe", "email": "jane.doe@example.com", "photo_url": "https://example.com/avatars/jane.jpg", "attributes": { … } }, "visibility": "public", "created_at": "2025-10-27T14:35:00.000Z", "attachments": [ { … } ] }