Skip to main content
GET
/
activity
/
messages
/
{id}
Ruby
Helo.configure do |config|
  config.access_token = "YOUR_BEARER_TOKEN"
end

id = "550e8400-e29b-41d4-a716-446655440000"
Helo::Activity.retrieve_message(id)
{
  "messageId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "channelId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "timestamp": "2023-11-07T05:31:56Z",
  "subject": "<string>",
  "from": {
    "email": "jsmith@example.com",
    "name": "<string>"
  },
  "to": [
    {
      "email": "jsmith@example.com",
      "name": "<string>"
    }
  ],
  "tracking": {
    "links": true,
    "opens": true
  },
  "events": [
    {
      "timestamp": "2023-11-07T05:31:56Z",
      "recipients": [
        "<string>"
      ],
      "details": {}
    }
  ],
  "cc": [
    {
      "email": "jsmith@example.com",
      "name": "<string>"
    }
  ],
  "bcc": [
    {
      "email": "jsmith@example.com",
      "name": "<string>"
    }
  ],
  "replyTo": [
    {
      "email": "jsmith@example.com",
      "name": "<string>"
    }
  ],
  "text": "<string>",
  "html": "<string>",
  "body": "<string>",
  "tags": [
    "<string>"
  ],
  "headers": {},
  "metadata": {},
  "attachments": [
    "<string>"
  ]
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string<uuid>
required

Response

OK

messageId
string<uuid>
required
channelId
string<uuid>
required
timestamp
string<date-time>
required
mailType
enum<string>
required
Available options:
transactional,
broadcast
mailSource
enum<string>
required
Available options:
api,
smtp
deliveryType
enum<string>
required
Available options:
live,
sandbox
status
enum<string>
required
Available options:
queued,
sent
subject
string
required
from
object
required
to
object[]
required
tracking
object
required
events
object[]
required
cc
object[]
bcc
object[]
replyTo
object[]
text
string
html
string
body
string
tags
string[]
headers
object
metadata
object
attachments
string[]