Update message

Update message attributes (right now only the is_read attribute is available for modification).

patch

Authorizations

Api-TokenstringRequired

Pass the API token in the Api-Token

Path parameters

sandbox_idinteger · int64 · min: 1Required

Unique sandbox ID

Example: 4015

message_idinteger · int64 · min: 1Required

Unique message ID

Example: 427

Body

Responses

200

Returns attributes of the updated message.

application/json

idintegerOptional

sandbox_idintegerOptional

subjectstringOptional

sent_atstringOptional

from_emailstringOptional

from_namestringOptional

to_emailstringOptional

to_namestringOptional

email_sizeintegerOptional

is_readbooleanOptional

created_atstringOptional

updated_atstringOptional

html_body_sizeintegerOptional

text_body_sizeintegerOptional

human_sizestringOptional

html_pathstringOptional

txt_pathstringOptional

raw_pathstringOptional

download_pathstringOptional

html_source_pathstringOptional

blacklists_report_infobooleanOptional

401

Returns unauthorized error message. Check your credentials.

application/json

403

Returns forbidden error message. Check your permissions.

application/json

404

Returns not found error message

application/json

patch/api/sandboxes/{sandbox_id}/messages/{message_id}

curl -X PATCH https://mailtrap.io/api/sandboxes/{sandbox_id}/messages/{message_id} \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{"message": {"is_read": "true"}}'

{
  "id": 427,
  "sandbox_id": 4324,
  "subject": "Test email",
  "sent_at": "2022-06-02T19:24:08.941Z",
  "from_email": "[e-mail]",
  "from_name": "John",
  "to_email": "[e-mail]",
  "to_name": "Mary",
  "email_size": 300,
  "is_read": false,
  "created_at": "2022-06-02T19:24:08.942Z",
  "updated_at": "2022-06-02T19:24:08.942Z",
  "html_body_size": 150,
  "text_body_size": 100,
  "human_size": "300 Bytes",
  "html_path": "/api/accounts/3761/sandboxes/4324/messages/427/body.html",
  "txt_path": "/api/accounts/3761/sandboxes/4324/messages/427/body.txt",
  "raw_path": "/api/accounts/3761/sandboxes/4324/messages/427/body.raw",
  "download_path": "/api/accounts/3761/sandboxes/4324/messages/427/body.eml",
  "html_source_path": "/api/accounts/3761/sandboxes/4324/messages/427/body.htmlsource",
  "blacklists_report_info": false,
  "smtp_information": {
    "ok": true,
    "data": {
      "mail_from_addr": "[e-mail]",
      "client_ip": "193.62.62.184"
    }
  }
}