Email Service API (v1.0.0)
Managing resources: viewing a list of resources, creating and deleting resources, and changing resource names. Managing domains: adding and deleting domains from a resource, viewing a list of domains in a resource, and checking domain verification status. Viewing resource mailing statistics. Removing emails from a stop list. The maximum number of requests to SMTP is 10,000 per minute. If the limit is exceeded, the method will return error 429. The average execution time for one request is 500 ms.
Get a list of resources
Get a list of resources in the project
Authorizations:
X-Auth-Token
query Parameters
| limit | integer <integer> Default: 100 Limit |
| offset | integer <integer> Default: 0 Offset |
Responses
Response samples
- 200
- 400
- 500
Content type
application/json
{- "limit": 0,
- "next_offset": 0,
- "resources": [
- {
- "created_at": "2024-05-26T15:16:53+00:00",
- "dedicated_sender": true,
- "dns_key": "xncFjGLFGkeq",
- "domains": [
- "domain1.ru",
- "domain2.ru"
], - "id": "448355c9-8c3a-4706-8ca4-ed2970fce631",
- "login": "1010",
- "name": "My SES Resource",
- "password": "NtV4FQscV5BQ",
- "project_id": "5c4272d6c6274435ae913cff6eceaf22",
- "status": "active",
- "updated_at": "2024-05-27T15:16:53+00:00"
}
]
}Create resource
Create resource
Authorizations:
X-Auth-Token
Request Body schema: application/jsonrequired
The scheme for creating a resource
| name required | string |
Responses
Request samples
- Payload
Content type
application/json
{- "name": "string"
}Response samples
- 201
- 400
- 500
Content type
application/json
{- "created_at": "2024-05-26T15:16:53+00:00",
- "dedicated_sender": true,
- "dns_key": "xncFjGLFGkeq",
- "id": "448355c9-8c3a-4706-8ca4-ed2970fce631",
- "login": "1010",
- "name": "My SES Resource",
- "password": "NtV4FQscV5BQ",
- "project_id": "5c4272d6c6274435ae913cff6eceaf22",
- "status": "active",
- "updated_at": "2024-05-27T15:16:53+00:00"
}Get resource
Get the resource by its identifier
Authorizations:
X-Auth-Token
path Parameters
| ses_id required | string <uuid> Resource ID |
Responses
Response samples
- 200
- 400
- 404
- 500
Content type
application/json
{- "resource": {
- "created_at": "2024-05-26T15:16:53+00:00",
- "dedicated_sender": true,
- "dns_key": "xncFjGLFGkeq",
- "id": "448355c9-8c3a-4706-8ca4-ed2970fce631",
- "login": "1010",
- "name": "My SES Resource",
- "password": "NtV4FQscV5BQ",
- "project_id": "5c4272d6c6274435ae913cff6eceaf22",
- "status": "active",
- "updated_at": "2024-05-27T15:16:53+00:00"
}
}Change resource name
Change the name of the created resource by its identifier
Authorizations:
X-Auth-Token
path Parameters
| ses_id required | string <uuid> Resource ID |
Request Body schema: application/jsonrequired
The scheme for updating a resource
| name required | string |
Responses
Request samples
- Payload
Content type
application/json
{- "name": "string"
}Response samples
- 200
- 400
- 500
Content type
application/json
{- "created_at": "2024-05-26T15:16:53+00:00",
- "dedicated_sender": true,
- "dns_key": "xncFjGLFGkeq",
- "id": "448355c9-8c3a-4706-8ca4-ed2970fce631",
- "login": "1010",
- "name": "My SES Resource",
- "password": "NtV4FQscV5BQ",
- "project_id": "5c4272d6c6274435ae913cff6eceaf22",
- "status": "active",
- "updated_at": "2024-05-27T15:16:53+00:00"
}Generate new resource password
Generate new password for the created resource by its identifier
Authorizations:
X-Auth-Token
path Parameters
| ses_id required | string <uuid> Resource ID |
Responses
Response samples
- 200
- 400
- 404
- 500
Content type
application/json
{- "created_at": "2024-05-26T15:16:53+00:00",
- "dedicated_sender": true,
- "dns_key": "xncFjGLFGkeq",
- "id": "448355c9-8c3a-4706-8ca4-ed2970fce631",
- "login": "1010",
- "name": "My SES Resource",
- "password": "NtV4FQscV5BQ",
- "project_id": "5c4272d6c6274435ae913cff6eceaf22",
- "status": "active",
- "updated_at": "2024-05-27T15:16:53+00:00"
}Transfer resource to other project
Transfer created resource to other project by resource identifier
Authorizations:
X-Auth-Token
path Parameters
| ses_id required | string <uuid> Resource ID |
Request Body schema: application/jsonrequired
The scheme for transfering a resource
| project_id required | string |
Responses
Request samples
- Payload
Content type
application/json
{- "project_id": "string"
}Response samples
- 200
- 400
- 404
- 500
Content type
application/json
{- "created_at": "2024-05-26T15:16:53+00:00",
- "dedicated_sender": true,
- "dns_key": "xncFjGLFGkeq",
- "id": "448355c9-8c3a-4706-8ca4-ed2970fce631",
- "login": "1010",
- "name": "My SES Resource",
- "password": "NtV4FQscV5BQ",
- "project_id": "5c4272d6c6274435ae913cff6eceaf22",
- "status": "active",
- "updated_at": "2024-05-27T15:16:53+00:00"
}Get complaints on messages
Get complaints on messages by period
Authorizations:
X-Auth-Token
path Parameters
| ses_id required | string <uuid> Resource ID |
query Parameters
| date_from required | string <date> Example: date_from=2024-05-25 Start date |
| date_to required | string <date> Example: date_to=2024-05-26 End date |
| limit | integer Default: 100 Example: limit=5 Limit |
| cursor_next | integer Default: 0 Example: cursor_next=20 Offset |
Responses
Response samples
- 200
- 400
- 403
- 500
Content type
application/json
{- "pagination": {
- "cursor_next": 0
}, - "report": [
- {
- "date": "2024-02-20 15:09:49",
- "domain": "domain.com",
- "email": "email1@inbox.ru",
- "issuen": 123456,
- "x_track_id": "299_20230621_135411"
}
], - "status": "ok"
}Get undelivered messages
Get undelivered messages by period
Authorizations:
X-Auth-Token
path Parameters
| ses_id required | string <uuid> Resource ID |
query Parameters
| date_from required | string <date> Example: date_from=2024-05-25 Start date |
| date_to required | string <date> Example: date_to=2024-05-26 End date |
| limit | integer Default: 100 Example: limit=5 Limit |
| cursor_next | integer Default: 0 Example: cursor_next=20 Offset |
Responses
Response samples
- 200
- 400
- 403
- 500
Content type
application/json
{- "pagination": {
- "cursor_next": 0
}, - "report": [
- {
- "code": 550,
- "date": "2024-02-20 15:09:49",
- "email": "email1@inbox.ru",
- "issuen": 123456,
- "message": "Unrouteable address",
- "x_track_id": "299_20230621_135411"
}
], - "status": "ok"
}Get the delivered message status
Get the delivered message status by message_id or x_track_id
Authorizations:
X-Auth-Token
path Parameters
| ses_id required | string <uuid> Resource ID |
query Parameters
| message_id | string <string> Message ID |
| x_track_id | string <string> X-Track-ID |
Responses
Response samples
- 200
- 400
- 403
- 500
Content type
application/json
{- "messages": [
- {
- "created_at": 1697746906,
- "message_id": "1qBv3w-0007Ls-CS11",
- "reason": "H=mx02.mail.icloud.com [17.56.9.29] CV=yes: 550 5.1.1 <example@icloud.com>: user does not exist",
- "status": "failed",
- "x_track_id": "299_20230621_135411"
}
], - "status": "ok"
}View resource statistics
View the statistics of sent messages of the resource
Authorizations:
X-Auth-Token
path Parameters
| ses_id required | string <uuid> Resource ID |
query Parameters
| date_from required | string <date> Example: date_from=2024-05-25 Date start |
| date_to required | string <date> Example: date_to=2024-05-26 Date end |
Responses
Response samples
- 200
- 400
- 500
Content type
application/json
{- "limit": 0,
- "next_offset": 0,
- "statistics": {
- "statistics_by_dates": [
- {
- "date": "string",
- "issuen": 0,
- "stat": {
- "bad": 0,
- "click_link": 0,
- "dup": 0,
- "fbl": 0,
- "gen_ok": 0,
- "open_msg": 0,
- "send_fail": 0,
- "send_ok": 0,
- "stop": 0,
- "total": 0,
- "trap": 0
}, - "status": "string"
}
], - "total": {
- "bad": 0,
- "click_link": 0,
- "dup": 0,
- "fbl": 0,
- "gen_ok": 0,
- "open_msg": 0,
- "send_fail": 0,
- "send_ok": 0,
- "stop": 0,
- "total": 0,
- "trap": 0
}
}
}Get a list of resource domains
Get a list of domains of the resource
Authorizations:
X-Auth-Token
path Parameters
| ses_id required | string <uuid> Resource ID |
query Parameters
| limit | integer <integer> Default: 16 Limit |
| offset | integer <integer> Default: 0 Offset |
Responses
Response samples
- 200
- 400
- 500
Content type
application/json
{- "domains": [
- "string"
], - "limit": 0,
- "next_offset": 0
}Link a domain to the resource
Link a domain to the resource
Authorizations:
X-Auth-Token
path Parameters
| ses_id required | string <uuid> Resource ID |
Request Body schema: application/jsonrequired
The scheme for adding a domain
| name required | string |
Responses
Request samples
- Payload
Content type
application/json
{- "name": "string"
}Response samples
- 201
- 400
- 500
Content type
application/json
{- "domain": "string"
}Check domain verification status
Check the correctness of SPF, DKIM, and DMARC domain record
Authorizations:
X-Auth-Token
path Parameters
| ses_id required | string <uuid> Resource ID |
query Parameters
| name required | string <string> Domain name |
Responses
Response samples
- 200
- 400
- 500
Content type
application/json
{- "verification": {
- "dkim_status": true,
- "dmarc_status": true,
- "dns_status": true,
- "spf_status": true,
- "verification_status": true
}
}Remove email from the stop list
Remove email from the stop list
Authorizations:
X-Auth-Token
path Parameters
| ses_id required | string <uuid> Resource ID |
query Parameters
| mail_from required | string <email> Sender's email address |
| email required | string <email> Email address to be removed from the stop list |
Responses
Response samples
- 400
- 500
Content type
application/json
{- "description": "string",
- "message": "string"
}Search email in the stop list
Search email in the stop list
Authorizations:
X-Auth-Token
path Parameters
| ses_id required | string <uuid> Resource ID |
query Parameters
| email required | string <email> Email address to be searched in the stop list |
Responses
Response samples
- 200
- 400
- 500
Content type
application/json
{- "bounces": [
- {
- "bounce": "string",
- "date": "string"
}
], - "domains": [
- "string"
], - "fbl_report": [
- {
- "date": "string",
- "domain": "string"
}
], - "status": "string",
- "user_unsubscribe": [
- {
- "date": "string",
- "domain": "string"
}
]
}Add email to the stop list
Add email to the stop list
Authorizations:
X-Auth-Token
path Parameters
| ses_id required | string <uuid> Resource ID |
query Parameters
| mail_from required | string <email> Sender's email address |
| email required | string <email> Email address to be added to the stop list |
Responses
Response samples
- 400
- 500
Content type
application/json
{- "description": "string",
- "message": "string"
}