Перейти к основному содержимому
API docs by Redocly

Email Service API (v1.0.0)

Managing email resources, their domains, retrieving mailing statistics, managing stop lists. Created resources will contain information about SMTP server to connect. 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

Resources

Managing resources: viewing a list of resources, creating and deleting resources, and changing resource names.

List resources

Returns a list of resources in the project.

Authorizations:
iam_token_project_scoped
query Parameters
limit
integer <integer>
Default: 100

Maximum number of items to return in response. Used for pagination.

offset
integer <integer>
Default: 0

Number of items to skip. Used for pagination.

Responses

Response samples

Content type
application/json
{
  • "limit": 0,
  • "next_offset": 0,
  • "resources": [
    ]
}

Create resource

Creates the resource.

Authorizations:
iam_token_project_scoped
Request Body schema: application/json
required

The scheme for creating a resource.

name
required
string

Name of the resource.

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Response samples

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"
}

Delete resource

Deletes the resource by its identifier.

Authorizations:
iam_token_project_scoped
path Parameters
ses_id
required
string <uuid>

Resource identifier.

Responses

Response samples

Content type
application/json
{
  • "description": "string",
  • "message": "string"
}

Get resource by identifier

Returns the resource by its identifier.

Authorizations:
iam_token_project_scoped
path Parameters
ses_id
required
string <uuid>

Resource identifier.

Responses

Response samples

Content type
application/json
{
  • "resource": {
    }
}

Change resource name

Changes the name of the created resource by its identifier.

Authorizations:
iam_token_project_scoped
path Parameters
ses_id
required
string <uuid>

Resource identifier.

Request Body schema: application/json
required

The scheme for updating a resource.

name
required
string

New name of the resource.

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Response samples

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

Generates new password for the created resource by its identifier

Authorizations:
iam_token_project_scoped
path Parameters
ses_id
required
string <uuid>

Resource identifier.

Responses

Response samples

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

Transfers created resource to other project by resource identifier.

Authorizations:
iam_token_project_scoped
path Parameters
ses_id
required
string <uuid>

Resource identifier.

Request Body schema: application/json
required

The scheme for transfering a resource.

project_id
required
string

Target project identifier for the transfer.

Responses

Request samples

Content type
application/json
{
  • "project_id": "string"
}

Response samples

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"
}

Domains

Managing domains: adding and deleting domains from a resource, viewing a list of domains in a resource, and checking domain verification status.

Unlink domain

Unlinks domain from the resource.

Authorizations:
iam_token_project_scoped
path Parameters
ses_id
required
string <uuid>

Resource identifier.

query Parameters
name
required
string

Name of the domain.

Responses

Response samples

Content type
application/json
{
  • "description": "string",
  • "message": "string"
}

List resource domains

Returns a list of domains of the resource.

Authorizations:
iam_token_project_scoped
path Parameters
ses_id
required
string <uuid>

Resource identifier.

query Parameters
limit
integer <integer>
Default: 16

Maximum number of items to return in response. Used for pagination.

offset
integer <integer>
Default: 0

Number of items to skip. Used for pagination.

Responses

Response samples

Content type
application/json
{
  • "domains": [
    ],
  • "limit": 0,
  • "next_offset": 0
}

Link domain

Links the domain to the resource.

Authorizations:
iam_token_project_scoped
path Parameters
ses_id
required
string <uuid>

Resource identifier.

Request Body schema: application/json
required

The scheme for adding a domain.

name
required
string

Domain name to link.

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "domain": "string"
}

Check domain verification status

Checks the correctness of SPF, DKIM, and DMARC domain record.

Authorizations:
iam_token_project_scoped
path Parameters
ses_id
required
string <uuid>

Resource identifier.

query Parameters
name
required
string <string>

Name of the domain.

Responses

Response samples

Content type
application/json
{
  • "verification": {
    }
}

Statistics

Getting statistics for email resources.

List message complaints by period

Returns a list of complaints on messages by period.

Authorizations:
iam_token_project_scoped
path Parameters
ses_id
required
string <uuid>

Resource identifier.

query Parameters
date_from
required
string <date>
Example: date_from=2024-05-25

Start date of the period.

date_to
required
string <date>
Example: date_to=2024-05-26

End date of the period.

limit
integer
Default: 100
Example: limit=5

Maximum number of items to return in response. Used for pagination.

cursor_next
integer
Default: 0
Example: cursor_next=20

Number of items to skip. Used for pagination.

Responses

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "report": [
    ],
  • "status": "ok"
}

Retrieve undelivered messages

Retrieves undelivered messages by period.

Authorizations:
iam_token_project_scoped
path Parameters
ses_id
required
string <uuid>

Resource identifier.

query Parameters
date_from
required
string <date>
Example: date_from=2024-05-25

Start date of the period.

date_to
required
string <date>
Example: date_to=2024-05-26

End date of the period.

limit
integer
Default: 100
Example: limit=5

Maximum number of items to return in response. Used for pagination.

cursor_next
integer
Default: 0
Example: cursor_next=20

Number of items to skip. Used for pagination.

Responses

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "report": [
    ],
  • "status": "ok"
}

Get the delivered message status

Returns status of the delivered message.

Authorizations:
iam_token_project_scoped
path Parameters
ses_id
required
string <uuid>

Resource identifier.

query Parameters
message_id
string <string>

Message identifier.

x_track_id
string <string>

Tracking identifier.

Responses

Response samples

Content type
application/json
{
  • "messages": [
    ],
  • "status": "ok"
}

Retrieve resource statistics

Retrieves the statistics of sent messages of the resource.

Authorizations:
iam_token_project_scoped
path Parameters
ses_id
required
string <uuid>

Resource identifier.

query Parameters
date_from
required
string <date>
Example: date_from=2024-05-25

Start date of the period.

date_to
required
string <date>
Example: date_to=2024-05-26

End date of the period.

Responses

Response samples

Content type
application/json
{
  • "limit": 0,
  • "next_offset": 0,
  • "statistics": {
    }
}

Stop lists

Managing stop lists: adding, removing, and searching for email addresses.

Remove email from stop list

Remove the email from the stop list.

Authorizations:
iam_token_project_scoped
path Parameters
ses_id
required
string <uuid>

Resource identifier.

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

Content type
application/json
{
  • "description": "string",
  • "message": "string"
}

Search email in stop list

Searchs the email in the stop list.

Authorizations:
iam_token_project_scoped
path Parameters
ses_id
required
string <uuid>

Resource identifier.

query Parameters
email
required
string <email>

Email address to be searched in the stop list.

Responses

Response samples

Content type
application/json
{
  • "bounces": [
    ],
  • "domains": [
    ],
  • "fbl_report": [
    ],
  • "status": "string",
  • "user_unsubscribe": [
    ]
}

Add email to stop list

Adds the email to the stop list.

Authorizations:
iam_token_project_scoped
path Parameters
ses_id
required
string <uuid>

Resource identifier.

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

Content type
application/json
{
  • "description": "string",
  • "message": "string"
}

Quotas

Viewing project and resource usage limits including maximum allowed resources and domains.

Retrieve project quotas

Retrieves quotas for the projects.

Authorizations:
iam_token_project_scoped

Responses

Response samples

Content type
application/json
{
  • "ses_resources": {
    }
}

Retrieve resource quotas

Retrieves quotas for resource.

Authorizations:
iam_token_project_scoped

Responses

Response samples

Content type
application/json
{
  • "domains": {
    }
}