Skip to main content
inputImportThreadMessageInput

Fields

The author of the message.

text
String!
required

The message body. Plain text unless format is MARKDOWN.

format

How to interpret text. Omit to keep plain text.

createdAt
String!
required

The original creation timestamp of this message in the source system.

externalId
ID!
required

An external ID for this message. Duplicate imports with the same externalId are skipped unless updateExisting is set.

attachmentIds
[ID!]

An array of attachments for the message.

emailMessageId
String

The value of the RFC 5322 Message-ID email header of the original message, with or without angle brackets. When set, subsequent email replies that reference this Message-ID are threaded onto the imported thread.

updateExisting
Boolean!
default:false

Update an existing imported message with the same externalId instead of skipping it.

Only text, format, attachmentIds, and emailMessageId can be updated. text, format, and attachmentIds replace the existing values. emailMessageId is updated only when provided; omit it to keep the existing value.

The import fails if:

  • No message with this externalId exists in the thread.
  • The thread is locked.
  • The message's type or author differs from the existing message.

NOTE messages are not supported. Use updateNote instead.