Scheduled messages

Use the GET request to retrieve information about scheduled messages. Scheduled messages are stored and queued until the Unix timestamp is reached. Please note that this timestamp is a minimal guarantee and that the email could be delayed due to server load.

Get list of scheduled messages

Get information on scheduled messages, such as subject, time of creation, and time of sending, with this GET request:

GET  https://api.mailersend.com/v1/message-schedules
1

Request parameters

JSON parameters are provided in dot notation

URL parameterTypeRequiredLimitationsDetails
domain_idstringno
statusstringnoStatuses: scheduled, sent, error
pageintno
limitintnoMin: 10, Max: 100Default: 25

Responses

Valid

Response Code: 200 OK
Response Headers:
	Content-Type: application/json
1
2
3
{
  "data": [
    {
      "message_id": "61e01c6a7f97913a17075262",
      "subject": "Hello from Company",
      "send_at": "2022-01-01T12:00:00.000000Z",
      "status": "scheduled",
      "status_message": null,
      "created_at": "2022-01-17:00:00.000000Z"
    },
    ...
  ]
}
1
2
3
4
5
6
7
8
9
10
11
12
13

Error

Response Code: 422 Unprocessable Entity
1

See - Validation errors

Get a single scheduled message

Get information about a specific scheduled message, like its subject, creation date, sending date and domain, with this GET request:

GET https://api.mailersend.com/v1/message-schedules/{message_id}
1

Request parameters

JSON parameterTypeRequiredLimitationsDetails
message_idstringyesMessage ID from the Send an email's response headers or Get scheduled messages response.

Responses

Valid

Response Code: 200 OK
Response Headers:
	Content-Type: application/json
1
2
3
{
  "data": {
    "message_id": "61e01f471053b349a5478a52",
    "subject": "Hello from Company",
    "send_at": "2022-01-01T12:00:00.000000Z",
    "status": "scheduled",
    "status_message": null,
    "created_at": "2022-01-01T17:00:00.000000Z",
    "domain": {
      "id": "7z3m5jgrogdpyo6n",
      "name": "mailersend.com",
      "created_at": "2022-01-01T12:00:00.000000Z",
      "updated_at": "2022-01-01T12:00:00.000000Z"
    },
    "message": {
      "id": "61e01f471053b349a5478a52",
      "created_at": "2022-01-01T12:00:00.000000Z",
      "updated_at": "2022-01-01T12:00:00.000000Z"
    }
  }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21

Error

Response Code: 404 Not Found
1

See - Validation errors

Delete a scheduled message

Delete a scheduled message with this DELETE request:

DELETE  https://api.mailersend.com/v1/message-schedules/{message_id}
1

Request parameters

URL parameterTypeRequiredLimitationsDetails
message_idstringyesA scheduled message can be deleted up to 10 minutes before the sending time.

Responses

Valid

Response Code: 204 OK
Response Body: [EMPTY]
1
2

Error

Response Code: 404 Not Found
1
Last Updated: