MessageInput

Message input fields for creation. 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.

message_typestring(MessageType)

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>"

authorobject(MessageAuthor)

The user who authored the message

visibilitystring(MessageVisibility)

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"

object_idstring

Unique identifier for the message in our system

Example:"123456"

attachmentsArray of objects(Attachment)

Array of attachments (can be empty)

{
  "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"
  },
  "visibility": "public",
  "object_id": "123456",
  "attachments": [
    { … }
  ]
}