Skip to main content

Fields

contactChannelIdentity : InkContactChannelIdentity! required

The contact channel identity.

conversationId : Int! required

The integer ID of the conversation this message belongs to.

conversationRelayId : String! required

The relay ID of the conversation this message belongs to.

delivery : InkMessageDelivery! required

The delivery status of the message.

displayContent : String! required

The content of the current email (without previous emails from the email thread).

fullContentHtml : String! required

The full email, including previous emails from the email thread if available, in HTML.

fullContentPlainText : String! required

The full email, including previous emails from the email thread if available, in plain text format.

isChannelEmail : Boolean! required

Is this an message an email.

occurredAt : DateTime! required

The time the message was sent/received.

tags : [InkTag!]! required

All Tags associated with a message.

toHandles : [String!]

The addresses that the message was sent to.

The example data in the variables and responses below are autogenerated values designed to resemble real inputs. They do not represent actual customer data, and in some cases may require additional validation.

Example

{ "attachments": [InkMessageAttachment], "cc": "east-by-house-discuss-feel", "contactChannelIdentity": InkContactChannelIdentity, "conversationId": 59652349, "conversationRelayId": "23778381", "delivery": InkMessageDelivery, "direction": "INBOUND", "displayContent": "this-every-result-check-much", "fromHandle": "paper-local-in-resource-activity", "fullContentHtml": "personal-fear-appear-kid-interesting", "fullContentPlainText": "agent-exactly-drive-certain-recently", "isChannelEmail": true, "occurredAt": "1992-05-31T08:02:43.910209+00:00", "subject": "my-reflect-sense-she-happen", "tags": [InkTag], "toHandles": "maintain-pattern-indicate-billion-ball" }