Skip to main content
GET
Get one sent message

Authorizations

Authorization
string
header
required

An API key from Settings, API keys. It starts with rc_live_.

Path Parameters

id
string
required

The log entry's ID.

Response

The log entry.

id
string
required
recipient_address
string
required

Who it was to. For a message sent from a conversation to several people, their addresses separated by commas.

direction
enum<string>
required
Available options:
outbound,
inbound
channel
enum<string>
required
Available options:
email
category
string
required

The kind of message, as the sender named it. general unless the sender said otherwise; inbox_new and inbox_reply for messages sent from a conversation.

status
enum<string>
required

suppressed: stopped before sending. sent: the email service accepted it and no delivery report has come back yet. delivered or bounced: what the delivery report said. failed: the email service did not accept it, or reported that it could not deliver it. received: a message that came in. A status never moves back.

Available options:
queued,
sent,
delivered,
failed,
bounced,
received,
suppressed
created_at
string<date-time>
required
updated_at
string<date-time>
required
tenant_id
string

Your organization's ID.

template_id
string | null

The template it was sent from.

person_id
string | null

The person it was to, when it was sent to a person on file.

provider
string | null

The email service that handled it. Null when it never reached one.

provider_message_id
string | null

The email service's own ID for the message.

subject
string | null

The subject as sent. The log keeps the subject, not the body.

The record it was about. email_thread for a message sent from a conversation, with the conversation's ID in related_entity_id.

payload_metadata
object

Detail about what happened. Only the keys that apply are present.