Message

Download schema

Look up sent messages, follow their delivery events, and retrieve the original source, HTML or text body.

Get message details

GET

https://api.lettermint.co/v1

/messages/{messageId}

Bearer

Returns detailed information about a specific message including optional nested resources.

Get message details › path Parameters

messageId

string · required

Get message details › Headers

Authorization

string · required

Bearer token. Format: Bearer {team_token}

Get message details › Responses

MessageData

MessageData

id

string · required

type

MessageType · enum · required

Enum values:

inbound

outbound

status

MessageStatus · enum · required

Enum values:

scheduled

pending

queued

quarantined

suppressed

processed

delivered

opened

status_changed_at

string | null · date-time · required

scheduled_at

string | null · date-time · required

tag

string | null · required

object[] · required

from_email

string · required

from_name

string | null · required

reply_to

array | null · required

subject

string | null · required

array | null · required

object | null · required

route_id

string · required

created_at

string · date-time · required

spam_score

number | null

Overall spam assessment score. Scores below 5 are clean, 5 through 10 indicate potential spam, scores above 10 and below 15 are likely spam, and 15 or higher is definite spam. Null means no assessment is available. Available on plans with Spam Insights

SpamSymbol[]

Detailed rules that contributed to the spam assessment. Available on plans with Spam Insights in individual-message responses

GET/messages/{messageId}

curl https://api.lettermint.co/v1/messages/:messageId \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "id": "id",
  "type": "inbound",
  "status": "scheduled",
  "status_changed_at": "2024-08-25T15:00:00Z",
  "scheduled_at": "2024-08-25T15:00:00Z",
  "tag": "tag",
  "tags": [
    {
      "name": "name",
      "value": "value"
    }
  ],
  "from_email": "from_email",
  "from_name": "from_name",
  "reply_to": [
    "string"
  ],
  "subject": "subject",
  "to": [
    {
      "email": "email",
      "name": "name"
    }
  ],
  "cc": [
    {
      "email": "email",
      "name": "name"
    }
  ],
  "bcc": [
    {
      "email": "email",
      "name": "name"
    }
  ],
  "attachments": [
    {
      "size": 0,
      "filename": "unknown",
      "content_id": "content_id",
      "content_type": "application/octet-stream"
    }
  ],
  "metadata": {
    "key": "string"
  },
  "spam_score": 0,
  "spam_symbols": [
    {
      "name": "name",
      "score": 0,
      "options": [],
      "description": "description"
    }
  ],
  "route_id": "route_id",
  "created_at": "2024-08-25T15:00:00Z"
}

json

application/json

Change the delivery time of a pending scheduled message

PATCH

https://api.lettermint.co/v1

/messages/{messageId}

Bearer

Change the delivery time of a pending scheduled message › path Parameters

messageId

string · required

Change the delivery time of a pending scheduled message › Headers

Authorization

string · required

Bearer token. Format: Bearer {team_token}

Change the delivery time of a pending scheduled message › Request Body

RescheduleMessageRequest

scheduled_at

string · maxLength: 255 · required

Change the delivery time of a pending scheduled message › Responses

message_id

string · required

required

scheduled_at

string | null · required

Cancel a pending scheduled message. Cancellation is final

POST

https://api.lettermint.co/v1

/messages/{messageId}/cancel

Bearer

Cancel a pending scheduled message. Cancellation is final › path Parameters

messageId

string · required

Cancel a pending scheduled message. Cancellation is final › Headers

Authorization

string · required

Bearer token. Format: Bearer {team_token}

Cancel a pending scheduled message. Cancellation is final › Responses

200

message_id

string · required

required

scheduled_at

string | null · required

List messages for the team

GET

https://api.lettermint.co/v1

/messages

Bearer

Returns a paginated list of messages with filtering and sorting capabilities.

List messages for the team › query Parameters

sort

string[]

Enum values:

type

-type

status

-status

from_email

-from_email

subject

-subject

Default: ["-created_at"]

filter[search]

string

Search in sender, recipients, and subject

filter[tags][0][name]

string

Exact tag name. Add more numbered pairs to match all pairs.

filter[tags][0][value]

string

Exact tag value.

filter[from_email]

string

Search by sender email (partial match)

filter[subject]

string

Search by subject (partial match)

page[size]

integer

Number of results per page

Default: 30

page[cursor]

string

Cursor for the next or previous page

object

filter[tags]

string

filter[overdue]

string

filter[project]

string

Filter by project ID

filter[type]

MessageType · enum

Enum values:

inbound

outbound

filter[status]

MessageStatus · enum

Enum values:

scheduled

pending

queued

quarantined

suppressed

processed

delivered

opened

filter[route_id]

string

Filter by route ID

filter[domain_id]

string

Filter by domain ID

filter[tag]

string

Filter by tag name

filter[from_date]

string

Filter messages created after this date

filter[to_date]

string

Filter messages created before this date

List messages for the team › Headers

Authorization

string · required

Bearer token. Format: Bearer {team_token}

List messages for the team › Responses

The cursor paginated collection of App.Data.Api.V1.Message.MessageListData

MessageListData[] · required

The list of items

links

string[] · required

object · required

GET/messages

curl https://api.lettermint.co/v1/messages \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "data": [
    {
      "id": "id",
      "type": "inbound",
      "status": "scheduled",
      "scheduled_at": "2024-08-25T15:00:00Z",
      "spam_score": 0,
      "from_email": "from_email",
      "from_name": "from_name",
      "subject": "subject",
      "to": [
        {
          "email": "email",
          "name": "name"
        }
      ],
      "cc": [
        {
          "email": "email",
          "name": "name"
        }
      ],
      "bcc": [
        {
          "email": "email",
          "name": "name"
        }
      ],
      "reply_to": [
        "string"
      ],
      "tag": "tag",
      "tags": [
        {
          "name": "name",
          "value": "value"
        }
      ],
      "status_changed_at": "status_changed_at",
      "created_at": "created_at"
    }
  ],
  "links": [
    "string"
  ],
  "meta": {
    "path": "path",
    "per_page": 0,
    "next_cursor": "next_cursor",
    "next_cursor_url": "next_cursor_url",
    "prev_cursor": "prev_cursor",
    "prev_cursor_url": "prev_cursor_url"
  }
}

json

application/json

Get message events

GET

https://api.lettermint.co/v1

/messages/{messageId}/events

Bearer

Returns a paginated list of events for a specific message with sorting capabilities.

Get message events › path Parameters

messageId

string · required

Get message events › query Parameters

page[size]

integer

The number of results that will be returned per page.

Default: 30

page[cursor]

string

The cursor to start the pagination from.

include_machine_events

boolean

Include security scanner, preview, and other machine-only tracking events. Supported privacy opens are included without this option.

sort

string[]

Enum values:

timestamp

-timestamp

event

-event

Get message events › Headers

Authorization

string · required

Bearer token. Format: Bearer {team_token}

Get message events › Responses

200

The cursor paginated collection of App.Data.Api.V1.Message.MessageEventData

MessageEventData[] · required

The list of items

links

string[] · required

object · required

Get message source

GET

https://api.lettermint.co/v1

/messages/{messageId}/source

Bearer

Returns the raw EML source of the message.

Get message source › path Parameters

messageId

string · required

Get message source › Headers

Authorization

string · required

Bearer token. Format: Bearer {team_token}

Get message source › Responses

200

string

Get message HTML content

GET

https://api.lettermint.co/v1

/messages/{messageId}/html

Bearer

Returns the HTML body of the message if available.

Get message HTML content › path Parameters

messageId

string · required

Get message HTML content › Headers

Authorization

string · required

Bearer token. Format: Bearer {team_token}

Get message HTML content › Responses

string | null

Get message plain text content

GET

https://api.lettermint.co/v1

/messages/{messageId}/text

Bearer

Returns the plain text body of the message if available.

Get message plain text content › path Parameters

messageId

string · required

Get message plain text content › Headers

Authorization

string · required

Bearer token. Format: Bearer {team_token}

Get message plain text content › Responses

string | null

Process one quarantined inbound message

POST

https://api.lettermint.co/v1

/messages/{messageId}/process

Bearer

Process one quarantined inbound message › path Parameters

messageId

string · uuid · required

The message UUID

Process one quarantined inbound message › Headers

Authorization

string · required

Bearer token. Format: Bearer {team_token}

Idempotency-Key

string

Optional key for an idempotent request

Process one quarantined inbound message › Responses

The message was queued for webhook delivery

object · required

Webhook Suppression

Lettermint Team API

Message

Download schema

Look up sent messages, follow their delivery events, and retrieve the original source, HTML or text body.

Get message details

GET

https://api.lettermint.co/v1

/messages/{messageId}

Bearer

Returns detailed information about a specific message including optional nested resources.

Get message details › path Parameters

messageId

string · required

Get message details › Headers

Authorization

string · required

Bearer token. Format: Bearer {team_token}

Get message details › Responses

MessageData

MessageData

id

string · required

type

MessageType · enum · required

Enum values:

inbound

outbound

status

MessageStatus · enum · required

Enum values:

scheduled

pending

queued

quarantined

suppressed

processed

delivered

opened

status_changed_at

string | null · date-time · required

scheduled_at

string | null · date-time · required

tag

string | null · required

object[] · required

from_email

string · required

from_name

string | null · required

reply_to

array | null · required

subject

string | null · required

array | null · required

object | null · required

route_id

string · required

created_at

string · date-time · required

spam_score

number | null

SpamSymbol[]

Detailed rules that contributed to the spam assessment. Available on plans with Spam Insights in individual-message responses

GET/messages/{messageId}

curl https://api.lettermint.co/v1/messages/:messageId \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "id": "id",
  "type": "inbound",
  "status": "scheduled",
  "status_changed_at": "2024-08-25T15:00:00Z",
  "scheduled_at": "2024-08-25T15:00:00Z",
  "tag": "tag",
  "tags": [
    {
      "name": "name",
      "value": "value"
    }
  ],
  "from_email": "from_email",
  "from_name": "from_name",
  "reply_to": [
    "string"
  ],
  "subject": "subject",
  "to": [
    {
      "email": "email",
      "name": "name"
    }
  ],
  "cc": [
    {
      "email": "email",
      "name": "name"
    }
  ],
  "bcc": [
    {
      "email": "email",
      "name": "name"
    }
  ],
  "attachments": [
    {
      "size": 0,
      "filename": "unknown",
      "content_id": "content_id",
      "content_type": "application/octet-stream"
    }
  ],
  "metadata": {
    "key": "string"
  },
  "spam_score": 0,
  "spam_symbols": [
    {
      "name": "name",
      "score": 0,
      "options": [],
      "description": "description"
    }
  ],
  "route_id": "route_id",
  "created_at": "2024-08-25T15:00:00Z"
}

json

application/json

Change the delivery time of a pending scheduled message

PATCH

https://api.lettermint.co/v1

/messages/{messageId}

Bearer

Change the delivery time of a pending scheduled message › path Parameters

messageId

string · required

Change the delivery time of a pending scheduled message › Headers

Authorization

string · required

Bearer token. Format: Bearer {team_token}

Change the delivery time of a pending scheduled message › Request Body

RescheduleMessageRequest

scheduled_at

string · maxLength: 255 · required

Change the delivery time of a pending scheduled message › Responses

message_id

string · required

required

scheduled_at

string | null · required

Cancel a pending scheduled message. Cancellation is final

POST

https://api.lettermint.co/v1

/messages/{messageId}/cancel

Bearer

Cancel a pending scheduled message. Cancellation is final › path Parameters

messageId

string · required

Cancel a pending scheduled message. Cancellation is final › Headers

Authorization

string · required

Bearer token. Format: Bearer {team_token}

Cancel a pending scheduled message. Cancellation is final › Responses

200

message_id

string · required

required

scheduled_at

string | null · required

List messages for the team

GET

https://api.lettermint.co/v1

/messages

Bearer

Returns a paginated list of messages with filtering and sorting capabilities.

List messages for the team › query Parameters

sort

string[]

Enum values:

type

-type

status

-status

from_email

-from_email

subject

-subject

Default: ["-created_at"]

filter[search]

string

Search in sender, recipients, and subject

filter[tags][0][name]

string

Exact tag name. Add more numbered pairs to match all pairs.

filter[tags][0][value]

string

Exact tag value.

filter[from_email]

string

Search by sender email (partial match)

filter[subject]

string

Search by subject (partial match)

page[size]

integer

Number of results per page

Default: 30

page[cursor]

string

Cursor for the next or previous page

object

filter[tags]

string

filter[overdue]

string

filter[project]

string

Filter by project ID

filter[type]

MessageType · enum

Enum values:

inbound

outbound

filter[status]

MessageStatus · enum

Enum values:

scheduled

pending

queued

quarantined

suppressed

processed

delivered

opened

filter[route_id]

string

Filter by route ID

filter[domain_id]

string

Filter by domain ID

filter[tag]

string

Filter by tag name

filter[from_date]

string

Filter messages created after this date

filter[to_date]

string

Filter messages created before this date

List messages for the team › Headers

Authorization

string · required

Bearer token. Format: Bearer {team_token}

List messages for the team › Responses

The cursor paginated collection of App.Data.Api.V1.Message.MessageListData

MessageListData[] · required

The list of items

links

string[] · required

object · required

GET/messages

curl https://api.lettermint.co/v1/messages \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "data": [
    {
      "id": "id",
      "type": "inbound",
      "status": "scheduled",
      "scheduled_at": "2024-08-25T15:00:00Z",
      "spam_score": 0,
      "from_email": "from_email",
      "from_name": "from_name",
      "subject": "subject",
      "to": [
        {
          "email": "email",
          "name": "name"
        }
      ],
      "cc": [
        {
          "email": "email",
          "name": "name"
        }
      ],
      "bcc": [
        {
          "email": "email",
          "name": "name"
        }
      ],
      "reply_to": [
        "string"
      ],
      "tag": "tag",
      "tags": [
        {
          "name": "name",
          "value": "value"
        }
      ],
      "status_changed_at": "status_changed_at",
      "created_at": "created_at"
    }
  ],
  "links": [
    "string"
  ],
  "meta": {
    "path": "path",
    "per_page": 0,
    "next_cursor": "next_cursor",
    "next_cursor_url": "next_cursor_url",
    "prev_cursor": "prev_cursor",
    "prev_cursor_url": "prev_cursor_url"
  }
}

json

application/json

Get message events

GET

https://api.lettermint.co/v1

/messages/{messageId}/events

Bearer

Returns a paginated list of events for a specific message with sorting capabilities.

Get message events › path Parameters

messageId

string · required

Get message events › query Parameters

page[size]

integer

The number of results that will be returned per page.

Default: 30

page[cursor]

string

The cursor to start the pagination from.

include_machine_events

boolean

Include security scanner, preview, and other machine-only tracking events. Supported privacy opens are included without this option.

sort

string[]

Enum values:

timestamp

-timestamp

event

-event

Get message events › Headers

Authorization

string · required

Bearer token. Format: Bearer {team_token}

Get message events › Responses

200

The cursor paginated collection of App.Data.Api.V1.Message.MessageEventData

MessageEventData[] · required

The list of items

links

string[] · required

object · required

Get message source

GET

https://api.lettermint.co/v1

/messages/{messageId}/source

Bearer

Returns the raw EML source of the message.

Get message source › path Parameters

messageId

string · required

Get message source › Headers

Authorization

string · required

Bearer token. Format: Bearer {team_token}

Get message source › Responses

200

string

Get message HTML content

GET

https://api.lettermint.co/v1

/messages/{messageId}/html

Bearer

Returns the HTML body of the message if available.

Get message HTML content › path Parameters

messageId

string · required

Get message HTML content › Headers

Authorization

string · required

Bearer token. Format: Bearer {team_token}

Get message HTML content › Responses

string | null

Get message plain text content

GET

https://api.lettermint.co/v1

/messages/{messageId}/text

Bearer

Returns the plain text body of the message if available.

Get message plain text content › path Parameters

messageId

string · required

Get message plain text content › Headers

Authorization

string · required

Bearer token. Format: Bearer {team_token}

Get message plain text content › Responses

string | null

Process one quarantined inbound message

POST

https://api.lettermint.co/v1

/messages/{messageId}/process

Bearer

Process one quarantined inbound message › path Parameters

messageId

string · uuid · required

The message UUID

Process one quarantined inbound message › Headers

Authorization

string · required

Bearer token. Format: Bearer {team_token}

Idempotency-Key

string

Optional key for an idempotent request

Process one quarantined inbound message › Responses

The message was queued for webhook delivery

object · required

Webhook Suppression