Simulate an inbound email
Creates an inbound email as if it were received at a provisioned address. Only available in sandbox. If the recipient is the agent address, the email agent may draft a reply.
Authorizations
API Key authentication. Use "Bearer YOUR_API_KEY".
Body
The email subject.
1 - 998The plain-text body.
1 - 20000The sender email address. Required when customer, owner, and thread are not set.
The provisioned recipient address (id or full address). Defaults to the account’s agent address. Ignored when thread is set.
Simulate mail from this customer. Uses the customer’s email as the From address.
Simulate mail from this owner. Uses the owner’s email as the From address.
Optional HTML body.
100000Optional CC recipients.
The thread to add this inbound message to. Sets In-Reply-To from the last message on the thread.
Response
Returns the message object if the request succeeded.
Unique identifier for the object.
Time at which the object was created. Measured in seconds since the Unix epoch.
message Plain-text body, common to all channels.
The communication channel for this thread. email today; additional channels may be added later.
email Whether the message was sent by the account or received from a counterparty.
inbound, outbound The thread this message belongs to.
The account that the object belongs to. Only returned if the request is made with a valid Yorlet-Context header.
Only returned if the object has been deleted.
Email-specific fields. Present when channel is email.