ZRM Docs
API ReferenceMessage

message.create

Type: Mutation · Auth: Workspace-aware

Input

FieldTypeRequiredDefaultDescription
conversationIdstringYesID of the associated conversation
directionenum(inbound, outbound, system)YesDirection
providerenum(telegram, whatsapp, discord, slack, microsoft_teams, ai_agent, email)YesProvider
externalMessageIdstringNoID of the associated external message
senderExternalIdstringNoID of the associated sender external
senderDisplayNamestringNoSender display name
bodyTextstringNoBody text
bodyRichJsonunknownNoBody rich json
attachmentRefsJsonunknownNoAttachment refs json
messageTypestringYes"text"Message type
sentAtstring.date-timeNoSent at
receivedAtstring.date-timeNoReceived at
deliveryStatusenum(pending, sent, delivered, read, failed)Yes"pending"Delivery status
metadataJsonobjectNoMetadata json
relevanceStatusenum(auto_relevant, confirmed, excluded)NoRelevance status
relevanceNotestringNoRelevance note

Example

{
  "conversationId": "550e8400-e29b-41d4-a716-446655440000",
  "direction": "inbound",
  "provider": "telegram",
  "externalMessageId": "550e8400-e29b-41d4-a716-446655440000",
  "senderExternalId": "550e8400-e29b-41d4-a716-446655440000",
  "senderDisplayName": "example",
  "messageType": "text",
  "deliveryStatus": "pending"
}

On this page