Mark a sandbox message read or unread

PATCH/api/v1/sandbox/messages/{id}
Requires anorganization API keywith the scopesandbox:write

Parameters

NameInTypeDescription
idrequiredpathstringThe id identifier.

Request body

  • readbooleanrequired

Request

PATCH/api/v1/sandbox/messages/{id}
curl -X PATCH 'https://app.mailyte.com/api/v1/sandbox/messages/01JBT8XQ2M9WYC3K4F6R7S8T9V' \
  -H 'Authorization: Bearer mk_live_YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
    "read": "<boolean>"
  }'
The key names its own organization, so no X-Organization-ID header is needed.

Response

Success.

  • dataobject
    • idstring

      ULID of the stored message.

    • inbox_idstring
    • subjectstring
    • header_fromstring

      The From header, as written.

    • header_toarray<string>

      The To header addresses.

    • envelope_rcptsarray<string>

      Every address the message was sent to, INCLUDING Bcc: blind recipients are in the envelope, never in the headers, so this is the only place they show.

    • size_bytesinteger
    • attachment_countinteger
    • sourcestringsmtp | api | inbound

      `api` for a test-mode API key send; `inbound` for mail sent to the inbox's `inbound_address`.

    • simulated_outcomestringdelivered | bounce | softbounce | complaint | suppressed

      The outcome simulated for this message (a `@sim.mailyte.com` address or an `X-Mailyte-Simulate` header). Null means the default: accepted, then delivered.

    • spam_scorenumber

      Null until the message has been scored; scoring runs after it arrives.

    • read_atstring

      When it was marked read. Null means unread.

    • received_atstring

      When the sandbox accepted it.

200application/json
{
  "read": true
}

Returned inside the standard envelope.

Errors

StatusWhen
401The API key is missing, unknown, revoked or expired. All four answer identically, on purpose: distinguishing them would confirm which keys exist.
403The key is valid but may not do this: it lacks the required scope, its IP allowlist does not include you, or this endpoint does not accept API keys.
404No such resource in this organization.
422The request was understood but the values were not acceptable.
429Too many requests, or the organization has spent its sending allowance. `Retry-After` says how long to wait.

Every status, with what causes it and what to do, is on the error reference.