Skip to content
Home/
/
Create Message

Create Message

Request

Used during synchronization to push new messages into your helpdesk. These messages may come from either the end-user or Fin. Note that the author of the Fin messages will be the agent selected to represent Fin on initial setup of the integration.

Security
BearerAuth
Bodyapplication/json
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)

conversation_idstring

ID of the parent conversation

Example:"conv_456"
POST
/create_message
curl -i -X POST \
  https://helpdesk.example.com/api/fin/create_message \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "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": [
      {
        "url": "https://example.com/files/pricing-guide.pdf",
        "filetype": "pdf",
        "filename": "Pricing Guide 2025"
      }
    ],
    "conversation_id": "conv_456"
  }'

Responses

Message created successfully

Bodyapplication/json
dataobject(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.

errorobject or null(ProblemDetails)

The error returned by the API. This is an RFC 7807 problem details object: https://www.rfc-editor.org/rfc/rfc7807.html.

Response
{
  "data": {
    "id": "msg_123",
    "conversation_id": "conv_456",
    "message_type": "comment",
    "body": "<p>Hi! I'd like to know more about your pricing plans.</p>",
    "author": { … },
    "visibility": "public",
    "created_at": "2025-10-27T14:30:00.000Z",
    "attachments": [ … ]
  }
}