Skip to main content

Message Object

Description​

Represents a message in an order conversation thread or general messaging system.

Declaration​

type Message {
_id: ID!
created: Date!
sender: MessageSender
subject: String
message: String!
fromBuyer: Boolean
flagged: Boolean!
archived: Boolean
isSystem: Boolean
content: String!
attachments: [MessageAttachment!]!
read: Boolean
orderId: String
orderIncId: Int
uri: String
via: String
}

Fields​

NameTypeDescription
_idID!Internal database identifier.
createdDate!Date when the message was created.
senderMessageSenderSender information for the message.
subjectStringSubject line of the message.
messageString!Message content text.
fromBuyerBooleanWhether the message was sent by the buyer.
flaggedBoolean!Whether the message has been flagged for attention.
archivedBooleanWhether the message has been archived. Archived messages are kept but hidden from the lists.
isSystemBooleanWhether the message is a system event rather than something a person wrote — a marketplace status change or payment notice, as opposed to a reply.
contentString!Formatted message content (HTML or processed text).
attachments[MessageAttachment!]!Attachments included with the message.
readBooleanWhether the message has been read.
orderIdStringOrder identifier string associated with this message.
orderIncIdIntIncremental numeric identifier of the order associated with this message.
uriStringURI identifier for the message.
viaStringChannel or method through which the message was sent (e.g., "email", "web", "api").