Skip to main content
​
id
string
required

Unique identifier for the object.

​
created
number
required

Time at which the object was created. Measured in seconds since the Unix epoch.

​
object
enum<string>
required
Available options:
message
​
body
string
required

Plain-text body, common to all channels.

​
channel
enum<string>
required

The communication channel for this thread. email today; additional channels may be added later.

Available options:
email
​
direction
enum<string>
required

Whether the message was sent by the account or received from a counterparty.

Available options:
inbound,
outbound
​
thread
string
required

The thread this message belongs to.

​
account
string

The account that the object belongs to. Only returned if the request is made with a valid Yorlet-Context header.

​
deleted
boolean
default:false

Only returned if the object has been deleted.

​
email
object

Email-specific fields. Present when channel is email.