Skip to navigation
API Referencemessages

Get Message

One message with its aggregate status, one entry per recipient in deliveries, and the events timeline across all of them. An id belonging to another workspace is a 404 — ids are never confirmed across the isolation boundary.

Authentication

AuthorizationBearer

A workspace key (rray_live_…, bound to one workspace) or the account’s platform key. Platform keys name the target workspace with RRay-Workspace-Id. See Credentials.

Path parameters

message_idstringRequired

Headers

RRay-Workspace-Idstring or nullOptional

The workspace to act on. Required with a platform key; rejected with a workspace key, which already carries its workspace — a matching value is rejected too, rather than silently ignored. An id that is not yours returns 404 workspace.not_found.

Response

Successful Response
idstring
Identifier of the message.
statusenum

Aggregate status across every delivery of this message; mixed when its deliveries disagree.

fromstring
Sender address as sent.
workspace_idstring
Workspace this message was sent from.
created_atdatetime

When the message was accepted (RFC 3339, UTC).

object"message"OptionalDefaults to message

Always message.

subjectstring or nullOptional
Subject line as sent.
deliverieslist of objectsOptionalDefaults to []
One entry per recipient address, with that recipient's own status.
attachmentslist of objectsOptionalDefaults to []
Descriptor of each attachment as sent. The bytes themselves are not retained.
eventslist of objectsOptionalDefaults to []
Delivery timeline across every recipient of this message, oldest first.

Errors

401
Unauthorized Error
404
Not Found Error
422
Unprocessable Entity Error
429
Too Many Requests Error
500
Internal Server Error