Mail365 API

https://www.mail365.ru/api.php
Admin
Mail365 API is a RESTful API platform that enables developers to manage contacts, perform SMS and...
Tokens:40,703
Snippets:122
Trust Score:8.3
Update:6 months ago
Show doc for...
Tokens:
Raw
### GET /forms

Source: https://www.mail365.ru/api.php

Retrieves a list of forms or integrations associated with the account.

```APIDOC
## GET /forms

### Description
Retrieves a paginated list of forms or integrations configured in the Mail365 account.

### Method
GET

### Endpoint
https://api.mail365.ru/forms

### Parameters
#### Query Parameters
- **Offset** (uint32) - Optional - Number of elements to skip
- **Limit** (uint32) - Optional - Number of elements to return (max 500, default 50)
- **apiKey** (string) - Required - Authentication API key

### Response
#### Success Response (200)
- **Id** (string) - Identifier of the form
- **Name** (string) - Name of the form
- **Key** (string) - Unique key for contact addition
- **ContactGroupId** (string) - ID of the target contact group
- **ContactGroupName** (string) - Name of the target contact group
- **ContactGroupDeleted** (boolean) - Status of the contact group
- **SendsConfirmation** (boolean) - Whether email confirmation is required

#### Response Example
[
  {
    "Id": "123",
    "Name": "Newsletter Form",
    "Key": "abc-123-xyz",
    "ContactGroupId": "group_01",
    "ContactGroupName": "Subscribers",
    "ContactGroupDeleted": false,
    "SendsConfirmation": true
  }
]
```

--------------------------------

### GET /balance

Source: https://www.mail365.ru/api.php

Retrieves the current account balance.

```APIDOC
## GET /balance

### Description
Retrieves the current account balance.

### Method
GET

### Endpoint
/balance

### Parameters
#### Query Parameters
- **apiKey** (string) - Required - API key for authentication.

### Response
#### Success Response (200)
- **balance** (decimal) - The current account balance.

#### Response Example
```json
{
  "balance": 100.50
}
```
```

--------------------------------

### GET /balance/tariff

Source: https://www.mail365.ru/api.php

Retrieves the current tariff plan details for the user.

```APIDOC
## GET /balance/tariff

### Description
Get the current active tariff plan.

### Method
GET

### Endpoint
/balance/tariff

### Parameters
#### Query Parameters
- **apiKey** (string) - Required - API Key

### Response
#### Success Response (200)
- **Title** (string) - Tariff name
- **PricePerSms** (decimal) - Price per SMS in RUB
- **PricePerEmail** (decimal) - Price per Email in RUB
- **MinPayment** (decimal) - Minimum payment for this tariff
```

--------------------------------

### GET /subAccounts/{login}

Source: https://www.mail365.ru/api.php

Retrieves information about a specific subaccount using its login.

```APIDOC
## GET /subAccounts/{login}

### Description
Retrieves information about a specific subaccount using its login.

### Method
GET

### Endpoint
/subAccounts/{login}

### Parameters
#### Path Parameters
- **login** (string) - Логин субаккаунта

#### Query Parameters
- **apiKey** (string) - api-Ключ

### Response
#### Success Response (200)
- **Login** (string) - Логин
- **FullName** (string) - Полное имя
- **Email** (string) - Email-адрес
- **Position** (string) - Должность
- **AccessRights** (string[]) - Права доступа (EditContact, SmsSending, EmailSending, SingleSmsSending, EditContactGroup)
- **IsBlocked** (boolean) - True — если субаккаунт заблокирован

#### Response Example
```json
{
  "Login": "subaccount_login",
  "FullName": "Sub Account Name",
  "Email": "subaccount@example.com",
  "Position": "Manager",
  "AccessRights": ["SmsSending", "EmailSending"],
  "IsBlocked": false
}
```
```

--------------------------------

### GET /emailSendings

Source: https://www.mail365.ru/api.php

Retrieves a list of created email campaigns, sorted from newest to oldest.

```APIDOC
## GET /emailSendings

### Description
Fetches information about previously created email campaigns with pagination support.

### Method
GET

### Endpoint
/emailSendings

### Parameters
#### Query Parameters
- **Offset** (uint32) - Optional - Number of elements to skip.
- **Limit** (uint32) - Optional - Number of elements to return (max 500, default 50).

### Response
#### Success Response (200)
- **Items** (array) - List of campaign objects.
- **SendingId** (string) - Campaign ID.
- **TotalSentCount** (int32) - Number of emails sent.
- **Price** (decimal) - Cost of the campaign in RUB.
- **DateOfStart** (datetime) - Campaign start date.
```

--------------------------------

### GET /blackListEmailAddresses

Source: https://www.mail365.ru/api.php

Retrieves a list of email addresses currently in the blacklist.

```APIDOC
## GET /blackListEmailAddresses

### Description
Get information about email addresses in the blacklist, sorted by recent addition.

### Method
GET

### Endpoint
/blackListEmailAddresses

### Parameters
#### Query Parameters
- **apiKey** (string) - Required - API Key
- **StartUtcDateTime** (datetime) - Optional - Filter start date
- **EndUtcDateTime** (datetime) - Optional - Filter end date
- **SearchString** (string) - Optional - Search query
- **Offset** (uint32) - Optional - Skip count
- **Limit** (uint32) - Optional - Limit count

### Response
#### Success Response (200)
- **Items** (array) - List of blacklisted emails
- **Email** (string) - Email address
- **UtcDateAdded** (datetime) - Addition date
- **Comments** (string) - Record comments
- **Reason** (string) - Reason for blacklisting
- **Total** (int32) - Total count
```

--------------------------------

### GET /smsSendings

Source: https://www.mail365.ru/api.php

Retrieves information about created SMS campaigns, ordered from newest to oldest.

```APIDOC
## GET /smsSendings

### Description
Retrieves information about created SMS campaigns, ordered from newest to oldest.

### Method
GET

### Endpoint
/smsSendings

### Parameters
#### Query Parameters
- **Offset** (uint32) - Optional - The number of initial elements to skip in the result.
- **Limit** (uint32) - Optional - The number of elements to return (maximum 500, default 50).

### Response
#### Success Response (200)
- **Items** (array) - A subset of campaign elements.
  - **UseRecepientTimeZone** (boolean) - True if SMS should be sent according to the recipient's local time.
  - **SmsTemplate** (string) - The main message template.
  - **AlternativeSmsTemplate** (string) - The message template for users with empty fields.
  - **SmsSenderId** (string) - The sender ID for SMS.
  - **CreatedDate** (datetime) - The date and time the SMS campaign was created.
  - **ContactGroupId** (string) - The ID of the contact group for the campaign.
  - **SendDateTime** (datetime) - The date and time the SMS campaign should be executed. Leave empty for immediate sending. If UseRecepientTimeZone is true, specify time in the recipient's timezone; otherwise, specify in UTC.
  - **Id** (string) - The ID of the campaign.
  - **ContactGroupName** (string) - The name of the contact group for the campaign.
  - **ContactFilters** (array) - A collection of filters used during the SMS campaign.
    - **Field** (string) - The field for filtering.
    - **Operator** (enum) - The logical operator (Eq, Neq, Contains, Startswith, EndsWith, Gte, Gt, Lte, Lt, ThisDayOfYear, ThisMonth, Between).
    - **Value** (string) - The filter value.

#### Response Example
```json
{
  "Items": [
    {
      "UseRecepientTimeZone": false,
      "SmsTemplate": "Hello, {{Имя}}!",
      "AlternativeSmsTemplate": "Hello!",
      "SmsSenderId": "MySender",
      "CreatedDate": "2023-10-27T10:00:00Z",
      "ContactGroupId": "group123",
      "SendDateTime": "2023-10-27T12:00:00Z",
      "Id": "campaign456",
      "ContactGroupName": "My Contacts",
      "ContactFilters": [
        {
          "Field": "City",
          "Operator": "Eq",
          "Value": "New York"
        }
      ]
    }
  ],
  "Offset": 0,
  "Limit": 50
}
```
```

--------------------------------

### GET /blackListEmailAddresses/{email}

Source: https://www.mail365.ru/api.php

Retrieves information about a specific email address from the blacklist.

```APIDOC
## GET /blackListEmailAddresses/{email}

### Description
Retrieves information about a specific email address from the blacklist.

### Method
GET

### Endpoint
/blackListEmailAddresses/{email}

### Parameters
#### Path Parameters
- **email** (string) - Required - The email address to retrieve information for

#### Query Parameters
- **Email** (string) - Required - Email address to get information about

### Response
#### Success Response (200)
- **Email** (string) - Email address added to the blacklist
- **UtcDateAdded** (datetime) - Date the email address was added to the blacklist (UTC)
- **Comments** (string) - Comment for the blacklist entry
- **Reason** (string) - Reason for adding the email address to the blacklist, accepts values: CustomerAdded, UnsubscribedByEmailLink

#### Response Example
{
  "Email": "test@example.com",
  "UtcDateAdded": "2023-10-27T10:10:00Z",
  "Comments": "Spam sender",
  "Reason": "CustomerAdded"
}
```

--------------------------------

### GET /emailSendings/{id}

Source: https://www.mail365.ru/api.php

Retrieves detailed information about a specific email sending campaign.

```APIDOC
## GET /emailSendings/{id}

### Description
Retrieves detailed information about a specific email sending campaign.

### Method
GET

### Endpoint
/emailSendings/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the email sending campaign.

#### Query Parameters
- **apiKey** (string) - Required - Your API key for authentication.

### Response
#### Success Response (200)
- **SendingId** (string) - The unique identifier of the sending.
- **SenderAddress** (string) - The sender's email address.
- **SubjectTemplate** (string) - The subject line template of the email.
- **AlternativeSubjectTemplate** (string) - An alternative subject line template.
- **BodyTemplate** (string) - The body content template of the email.
- **AlternativeBodyTemplate** (string) - An alternative body content template.
- **ContactGroupName** (string) - The name of the contact group used for the sending.
- **ContactGroupId** (string) - The ID of the contact group.
- **TotalSentCount** (int32) - The total number of emails sent.
- **TotalDeliveredCount** (int32) - The total number of emails successfully delivered.
- **TotalBouncedCount** (int32) - The total number of emails that bounced.
- **TotalSpamCount** (int32) - The total number of emails marked as spam.
- **TotalOpenedCount** (int32) - The total number of emails opened.
- **Price** (decimal) - The total cost of the sending in rubles.
- **DateOfStart** (datetime) - The date and time when the sending was initiated.

#### Response Example
{
  "SendingId": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
  "SenderAddress": "sender@example.com",
  "SubjectTemplate": "Welcome!",
  "AlternativeSubjectTemplate": "Hello!",
  "BodyTemplate": "<p>Thank you for signing up.</p>",
  "AlternativeBodyTemplate": "<p>Thanks for joining.</p>",
  "ContactGroupName": "New Users",
  "ContactGroupId": "group-123",
  "TotalSentCount": 1000,
  "TotalDeliveredCount": 950,
  "TotalBouncedCount": 20,
  "TotalSpamCount": 30,
  "TotalOpenedCount": 500,
  "Price": 50.00,
  "DateOfStart": "2023-10-27T10:00:00Z"
}
```

--------------------------------

### GET /emailAddresses

Source: https://www.mail365.ru/api.php

Retrieves a list of sender email addresses in alphabetical order.

```APIDOC
## GET /emailAddresses

### Description
Retrieves a list of sender email addresses in alphabetical order.

### Method
GET

### Endpoint
/emailAddresses

### Parameters
#### Query Parameters
- **apiKey** (string) - Required - Your API key.

### Response
#### Success Response (200)
(No specific response body details provided in the source text for success.)

#### Response Example
(No example provided in the source text.)
```

--------------------------------

### GET /autoSmsSendings

Source: https://www.mail365.ru/api.php

Retrieves a list of automated SMS campaigns, ordered from newest to oldest, with support for pagination.

```APIDOC
## GET /autoSmsSendings

### Description
Fetches a paginated list of automated SMS campaigns configured in the system.

### Method
GET

### Endpoint
/autoSmsSendings

### Parameters
#### Query Parameters
- **Offset** (uint32) - Optional - Number of items to skip.
- **Limit** (uint32) - Optional - Number of items to return (max 500).

### Request Example
GET /autoSmsSendings?Offset=0&Limit=50

### Response
#### Success Response (200)
- **List** (array) - Array of campaign objects containing ID, Status, and configuration details.

#### Response Example
[
  {
    "Id": "auto_987",
    "Status": "Active"
  }
]
```

--------------------------------

### GET /emailAddresses

Source: https://www.mail365.ru/api.php

Retrieves a list of verified sender email addresses. Supports pagination with Offset and Limit parameters.

```APIDOC
## GET /emailAddresses

### Description
Retrieves a list of verified sender email addresses. Supports pagination with Offset and Limit parameters.

### Method
GET

### Endpoint
/emailAddresses

### Parameters
#### Query Parameters
- **Offset** (uint32) - Optional - The number of initial elements to skip in the result.
- **Limit** (uint32) - Optional - The number of elements to return (maximum 500, default 50).

### Response
#### Success Response (200)
- **Items** (array) - A subset of selected elements.
  - **Email** (string) - The email address.
  - **Name** (string) - The sender's name.
- **Total** (int32) - The total number of elements.

#### Response Example
```json
{
  "Items": [
    {
      "Email": "sender@example.com",
      "Name": "Sender Name"
    }
  ],
  "Total": 100
}
```
```

--------------------------------

### GET /contactGroups/{id}/columns/{index}

Source: https://www.mail365.ru/api.php

Get information about a specific contact group column. Retrieves details of a particular column within a contact group.

```APIDOC
## GET /contactGroups/{id}/columns/{index}

### Description
Get information about a specific contact group column. Retrieves details of a particular column within a contact group.

### Method
GET

### Endpoint
/contactGroups/{id}/columns/{index}

### Parameters
#### Path Parameters
- **id** (string) - Required - Identifier of the contact group. Can be obtained using the GET: /contactGroups method.
- **index** (string) - Required - Index of the column, starting from zero. Can be obtained using the GET: /contactGroups/{id}/columns method.

#### Query Parameters
- **apiKey** (string) - Required - api-Key

### Response
#### Success Response (200)
- **Title** (string) - The title of the column.
- **Type** (enum) - The type of the column (String, Number, Bool, Date, Decimal).
- **State** (enum) - The current state of the column (Hidden, Visible).
- **Index** (int32) - The index of the column, starting from zero.
- **Preset** (boolean) - True if the column is preset and cannot be renamed.

#### Response Example
```json
{
  "Title": "Example Title",
  "Type": "String",
  "State": "Visible",
  "Index": 0,
  "Preset": false
}
```
```

--------------------------------

### Create Email Campaign from Template via POST

Source: https://www.mail365.ru/api.php

Initializes a new email campaign using a template ID. Requires sender email, contact group, and optional scheduling parameters.

```json
{
  "SenderEmailAddress": "sender@example.com",
  "ContactGroupId": "group_123",
  "SendDateTime": "2023-10-27T10:00:00",
  "PostponeScheduling": true,
  "SubjectTemplate": "Hello {{Имя}}"
}
```

--------------------------------

### Authentication

Source: https://www.mail365.ru/api.php

Details on how to authenticate API requests using an API key.

```APIDOC
## Authentication

### Description
To access any Mail365 API function, you must authenticate your requests using an API key obtained from your personal account section (Profile).

### Authentication Methods

API keys can be passed in three ways:

1.  **Via `Authorization` HTTP Header (Recommended)**:
    Add the following header to your request:
    ```
    Authorization: ApiKey xxx-xxxxxxxxxxxxxxx
    ```
    Replace `xxx-xxxxxxxxxxxxxxx` with your actual API key.

2.  **As a Query Parameter**: 
    Include the `apiKey` parameter in the URL. For example:
    ```
    https://api.mail365.ru/balance?apiKey=xxx-xxxxxxxxxxxxxxx
    ```
    Replace `xxx-xxxxxxxxxxxxxxx` with your actual API key.

3.  **As a POST Request Body Parameter**: 
    Include the `apiKey` in the JSON body of a POST request:
    ```json
    { "apiKey" : "xxx-xxxxxxxxxxxxxxx" }
    ```
    Replace `xxx-xxxxxxxxxxxxxxx` with your actual API key.
```

--------------------------------

### POST /emailSendings

Source: https://www.mail365.ru/api.php

Creates a new email campaign based on a pre-defined template identified by name.

```APIDOC
## POST /emailSendings

### Description
Creates a new email campaign using a template. The template is selected by its name provided in the query string.

### Method
POST

### Endpoint
/emailSendings?Name={Name}

### Parameters
#### Query Parameters
- **Name** (string) - Required - The name of the email template.

#### Request Body
- **SenderEmailAddress** (string) - Required - Verified sender email address.
- **ContactGroupId** (string) - Required - ID of the contact group.
- **FilterId** (string) - Optional - ID of a saved filter within the group.
- **SendDateTime** (datetime) - Required - Scheduled date and time for the campaign.
- **UnsubscribeText** (string) - Optional - Text for the unsubscribe link.
- **SubscribeReason** (string) - Optional - Text explaining the subscription reason.
- **PostponeScheduling** (boolean) - Optional - If true, the campaign is not queued immediately.
- **SubjectTemplate** (string) - Optional - Custom subject line template.
- **AlternativeSubjectTemplate** (string) - Optional - Custom alternative subject line template.
- **WebVersionText** (string) - Optional - Text for the web version link.
```

--------------------------------

### POST /emailSendings/{id}/schedule

Source: https://www.mail365.ru/api.php

Queues a previously created email sending for dispatch.

```APIDOC
## POST /emailSendings/{id}/schedule

### Description
Queues a previously created email sending for dispatch.

### Method
POST

### Endpoint
/emailSendings/{id}/schedule

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the email sending.

#### Query Parameters
None

#### Request Body
None

### Request Example
(No request body)

### Response
#### Success Response (200)
- **message** (string) - Confirmation message.

#### Response Example
```json
{
  "message": "Email sending scheduled successfully."
}
```
```

--------------------------------

### GET /blackListPhoneNumbers/{phoneNumber}

Source: https://www.mail365.ru/api.php

Retrieves information about a specific blacklisted phone number.

```APIDOC
## GET /blackListPhoneNumbers/{phoneNumber}

### Description
Retrieves the details of a specific phone number currently in the blacklist.

### Method
GET

### Endpoint
/blackListPhoneNumbers/{phoneNumber}

### Parameters
#### Path Parameters
- **phoneNumber** (string) - Required - The phone number to query.

#### Query Parameters
- **apiKey** (string) - Required - API authentication key.

### Response
#### Success Response (200)
- **PhoneNumber** (string) - The phone number.
- **UtcDateAdded** (datetime) - Date added to blacklist.
- **Comments** (string) - Associated comment.
- **Reason** (string) - Reason for blacklisting.
```

--------------------------------

### POST /emailSendings

Source: https://www.mail365.ru/api.php

Creates a new email campaign. Requires sender details, subject, body, and contact group information.

```APIDOC
## POST /emailSendings

### Description
Creates a new email campaign. Requires sender details, subject, body, and contact group information.

### Method
POST

### Endpoint
/emailSendings

### Parameters
#### Request Body
- **SenderEmailAddress** (string) - Required - The sender's email address. Must be in the list of verified sender addresses.
- **SubjectTemplate** (string) - Required - The template for the main email subject.
- **BodyTemplate** (string) - Required - The template for the main email body.
- **AlternativeSubjectTemplate** (string) - Optional - The template for the subject for users with empty fields.
- **AlternativeBodyTemplate** (string) - Optional - The template for the body for users with empty fields.
- **ContactGroupId** (string) - Required - The ID of the contact group to send the campaign to.
- **FilterId** (string) - Optional - The ID of a saved filter within the contact group. If not specified, the campaign is sent to all contacts in the group.
- **SendDateTime** (datetime) - Optional - The date and time to schedule the campaign.
- **UnsubscribeText** (string) - Optional - The text for the unsubscribe link.
- **SubscribeReason** (string) - Optional - The text explaining the reason for subscription.
- **PostponeScheduling** (boolean) - Optional - If true, the campaign is not scheduled immediately and requires a separate call to queue.
- **WebVersionText** (string) - Optional - The text for the link to view the email in a web browser.

### Request Example
```json
{
  "SenderEmailAddress": "sender@example.com",
  "SubjectTemplate": "Our Latest Newsletter",
  "BodyTemplate": "<p>Check out our new offers!</p>",
  "ContactGroupId": "group123",
  "SendDateTime": "2023-10-27T10:00:00Z",
  "PostponeScheduling": false
}
```

### Response
#### Success Response (200)
- **SendingId** (string) - The ID of the created campaign.
- **SenderAddress** (string) - The sender's email address.
- **SubjectTemplate** (string) - The subject template.
- **AlternativeSubjectTemplate** (string) - The alternative subject template.
- **BodyTemplate** (string) - The body template.
- **AlternativeBodyTemplate** (string) - The alternative body template.
- **ContactGroupName** (string) - The name of the contact group.
- **ContactGroupId** (string) - The ID of the contact group.
- **TotalSentCount** (int32) - The total number of emails sent.
- **TotalDeliveredCount** (int32) - The total number of emails delivered.
- **TotalBouncedCount** (int32) - The total number of bounced emails.
- **TotalSpamCount** (int32) - The total number of emails marked as spam.
- **TotalOpenedCount** (int32) - The total number of emails opened.
- **Price** (decimal) - The cost of the campaign in rubles.
- **DateOfStart** (datetime) - The date the campaign was started.

#### Response Example
```json
{
  "SendingId": "sending456",
  "SenderAddress": "sender@example.com",
  "SubjectTemplate": "Our Latest Newsletter",
  "AlternativeSubjectTemplate": "Newsletter",
  "BodyTemplate": "<p>Check out our new offers!</p>",
  "AlternativeBodyTemplate": "<p>Offers inside!</p>",
  "ContactGroupName": "All Customers",
  "ContactGroupId": "group123",
  "TotalSentCount": 1000,
  "TotalDeliveredCount": 980,
  "TotalBouncedCount": 5,
  "TotalSpamCount": 10,
  "TotalOpenedCount": 500,
  "Price": 50.00,
  "DateOfStart": "2023-10-27T10:00:00Z"
}
```
```

--------------------------------

### GET /balance/payments

Source: https://www.mail365.ru/api.php

Retrieves the history of payments and orders, sorted by recent activity.

```APIDOC
## GET /balance/payments

### Description
Retrieve the history of orders and payments, starting from the most recent.

### Method
GET

### Endpoint
/balance/payments

### Parameters
#### Query Parameters
- **apiKey** (string) - Required - API Key
- **Offset** (uint32) - Optional - Number of elements to skip
- **Limit** (uint32) - Optional - Number of elements to return (max 500, default 50)

### Response
#### Success Response (200)
- **Items** (array) - Subset of payment items
- **PaymentDate** (datetime) - Date of payment
- **Type** (string) - Payment method
- **Amount** (decimal) - Bill amount
- **BonusAmount** (decimal) - Bonus amount
- **BillNo** (string) - Bill number
- **CreationDate** (datetime) - Creation date
- **State** (string) - Bill state
- **Total** (int32) - Total count of elements
```

--------------------------------

### Balance and Tariffs API

Source: https://www.mail365.ru/api.php

Provides information about account balance, transaction history, and available tariffs.

```APIDOC
## Balance and Tariffs API

### Description
Accesses your account balance, transaction history, and details about available service tariffs.

### Method
GET

### Endpoint
/balance

### Description
Retrieves the current account balance in rubles.

### Response
#### Success Response (200)
- **balance** (number) - The current account balance.

#### Response Example
```json
{
  "balance": 1500.75
}
```

---

### Method
GET

### Endpoint
/transactions/history

### Description
Retrieves the history of orders and payments.

### Response
#### Success Response (200)
- **history** (array) - A list of transaction records.
  - **transaction_id** (string) - Unique identifier for the transaction.
  - **type** (string) - Type of transaction (e.g., 'order', 'payment').
  - **amount** (number) - The amount of the transaction.
  - **timestamp** (string) - The date and time of the transaction.

#### Response Example
```json
{
  "history": [
    {
      "transaction_id": "txn_abc123",
      "type": "payment",
      "amount": 500.00,
      "timestamp": "2024-10-25 11:30:00"
    }
  ]
}
```

---

### Method
GET

### Endpoint
/tariffs/current

### Description
Retrieves information about the currently active tariff plan.

### Response
#### Success Response (200)
- **tariff** (object) - Details of the current tariff.
  - **tariff_id** (string) - The ID of the tariff.
  - **name** (string) - The name of the tariff plan.
  - **price_per_unit** (number) - The cost per unit (e.g., per SMS, per email).

#### Response Example
```json
{
  "tariff": {
    "tariff_id": "tariff_std_01",
    "name": "Standard Plan",
    "price_per_unit": 0.50
  }
}
```

---

### Method
GET

### Endpoint
/tariffs/all

### Description
Retrieves a list of all available tariff plans.

### Response
#### Success Response (200)
- **tariffs** (array) - A list of all available tariffs.
  - **tariff_id** (string) - The ID of the tariff.
  - **name** (string) - The name of the tariff plan.
  - **description** (string) - A description of the tariff.

#### Response Example
```json
{
  "tariffs": [
    {
      "tariff_id": "tariff_std_01",
      "name": "Standard Plan",
      "description": "Basic plan for regular usage."
    },
    {
      "tariff_id": "tariff_prem_01",
      "name": "Premium Plan",
      "description": "Advanced features and higher limits."
    }
  ]
}
```
```

--------------------------------

### POST /emailSendings/templateName/{name}

Source: https://www.mail365.ru/api.php

Creates a new email sending using a template identified by its name.

```APIDOC
## POST /emailSendings/templateName/{name}

### Description
Creates a new email sending using a template identified by its name.

### Method
POST

### Endpoint
/emailSendings/templateName/{name}

### Parameters
#### Path Parameters
- **name** (string) - Required - The name of the template.

#### Query Parameters
None

#### Request Body
- **SenderEmailAddress** (string) - Required - The sender's email address. Must be among the sender's verified addresses.
- **ContactGroupId** (string) - Required - The ID of the contact group for the sending. Can be obtained via GET: /contactGroups.
- **FilterId** (string) - Optional - The ID of a saved contact filter within the group. If not specified, all contacts in the group will be used.
- **SendDateTime** (datetime) - Optional - The date and time to send the email.
- **UnsubscribeText** (string) - Optional - The text for the unsubscribe link.
- **SubscribeReason** (string) - Optional - The text explaining the reason for subscription.
- **PostponeScheduling** (boolean) - Optional - If true, the sending will not be queued immediately and will require a separate call to schedule. If ContactGroupId is not provided, this must be true, and recipients must be added via separate calls.
- **SubjectTemplate** (string) - Optional - The subject line template for the main message.
- **AlternativeSubjectTemplate** (string) - Optional - The subject line template for users with empty fields.
- **WebVersionText** (string) - Optional - The text for the web version link.

### Request Example
```json
{
  "SenderEmailAddress": "sender@example.com",
  "ContactGroupId": "group123",
  "SendDateTime": "2023-10-27T10:00:00Z",
  "UnsubscribeText": "Unsubscribe here",
  "SubscribeReason": "You are receiving this email because you opted in.",
  "PostponeScheduling": false,
  "SubjectTemplate": "Our Latest News",
  "AlternativeSubjectTemplate": "News Update",
  "WebVersionText": "View in browser"
}
```

### Response
#### Success Response (200)
- **emailSendingId** (string) - The ID of the created email sending.

#### Response Example
```json
{
  "emailSendingId": "sending789"
}
```
```

--------------------------------

### GET /singleEmail/{id}

Source: https://www.mail365.ru/api.php

Retrieves the status and delivery information for a previously sent email.

```APIDOC
## GET /singleEmail/{id}

### Description
Fetch details about a sent email message using its unique identifier.

### Method
GET

### Endpoint
/singleEmail/{id}

### Parameters
#### Path Parameters
- **id** (guid) - Required - The sent message identifier.

### Response
#### Success Response (200)
- **Email** (string) - Recipient address.
- **IsDelivered** (boolean) - Delivery status.
```

--------------------------------

### POST /subAccounts

Source: https://www.mail365.ru/api.php

Creates a new subaccount. The details of the subaccount to be created are provided in the request body.

```APIDOC
## POST /subAccounts

### Description
Creates a new subaccount. The details of the subaccount to be created are provided in the request body.

### Method
POST

### Endpoint
/subAccounts

### Parameters
#### Query Parameters
- **apiKey** (string) - api-Ключ
- **Offset** (integer) - Количество начальных элементов в результате, которые надо пропустить
- **Limit** (integer) - Количество элементов, которые необходимо вернуть (максимум — 500, по умолчанию — 50)

#### Request Body
- **Login** (string) - Логин субаккаунта
- **Email** (string) - Email-адрес субаккаунта
- **Password** (string) - Пароль субаккаунта
- **ContactGroupAccessType** (enum) - Тип прав на группы контактов (All, Include, Exclude)
- **ContactGroupIdsAccess** (string[]) - Идентификаторы контактных групп, к которым устанавливаются права в свойстве ContactGroupAccessType, в случае Include или Exclude
- **Emails** (string[]) - Разрешённые email-адреса отправителя
- **SenderIds** (string[]) - Разрешённые имена отправителя СМС (Sender ID)
- **FullName** (string) - Полное имя пользователя субаккаунта
- **AccessRights** (string[]) - Права доступа (EditContact, SmsSending, EmailSending, SingleSmsSending, EditContactGroup)
- **Position** (string) - Должность

### Request Example
```json
{
  "Login": "subaccount_login",
  "Email": "subaccount@example.com",
  "Password": "secure_password",
  "ContactGroupAccessType": "All",
  "Emails": ["sender@example.com"],
  "SenderIds": ["SenderID1"],
  "FullName": "Sub Account Name",
  "AccessRights": ["SmsSending", "EmailSending"],
  "Position": "Manager"
}
```

### Response
#### Success Response (200)
- **Login** (string) - Логин
- **FullName** (string) - Полное имя
- **Email** (string) - Email-адрес
- **Position** (string) - Должность
- **AccessRights** (string[]) - Права доступа (EditContact, SmsSending, EmailSending, SingleSmsSending, EditContactGroup)
- **IsBlocked** (boolean) - True — если субаккаунт заблокирован

#### Response Example
```json
{
  "Login": "subaccount_login",
  "FullName": "Sub Account Name",
  "Email": "subaccount@example.com",
  "Position": "Manager",
  "AccessRights": ["SmsSending", "EmailSending"],
  "IsBlocked": false
}
```
```

--------------------------------

### POST /smsSendings/{id}/schedule

Source: https://www.mail365.ru/api.php

Queues a previously created SMS campaign for sending.

```APIDOC
## POST /smsSendings/{id}/schedule

### Description
Queues a previously created SMS campaign for sending.

### Method
POST

### Endpoint
/smsSendings/{id}/schedule

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the SMS campaign.

#### Query Parameters
*Note: Filter parameters are passed via the query string.*
- **Id** (string) - Required - The ID of the SMS campaign.

#### Request Body
*No request body specified in the source.*

### Request Example
```json
{
  "apiKey": "your_api_key",
  "Id": "campaign_id"
}
```

### Response
#### Success Response (200)
*No specific response body details provided in the source.*
```

--------------------------------

### POST /emailSendings/cost

Source: https://www.mail365.ru/api.php

Calculates the estimated cost for a specific email campaign configuration.

```APIDOC
## POST /emailSendings/cost

### Description
Calculates the cost of an email campaign based on the target contact group and optional filters.

### Method
POST

### Endpoint
/emailSendings/cost

### Parameters
#### Request Body
- **ContactGroupId** (string) - Required - ID of the contact group.
- **FilterId** (string) - Optional - ID of a saved filter within the group.

### Response
#### Success Response (200)
- **Price** (decimal) - Estimated cost of the campaign.
```

--------------------------------

### GET /blackListPhoneNumbers

Source: https://www.mail365.ru/api.php

Retrieves information about phone numbers in the blacklist, sorted by the most recently added.

```APIDOC
## GET /blackListPhoneNumbers

### Description
Retrieves information about phone numbers in the blacklist, sorted by the most recently added.

### Method
GET

### Endpoint
/blackListPhoneNumbers

### Parameters
#### Query Parameters
- **StartUtcDateTime** (datetime) - Optional - Filter by the date of addition, lower bound (UTC)
- **EndUtcDateTime** (datetime) - Optional - Filter by the date of addition, upper bound (UTC)
- **SearchString** (string) - Optional - Search string for the phone number
- **Offset** (uint32) - Optional - Number of initial elements in the result to skip
- **Limit** (uint32) - Optional - Number of elements to return (maximum 500, default 50)

### Response
#### Success Response (200)
- **Items** (array) - Selected subset of elements
  - **PhoneNumber** (string) - Phone number added to the blacklist
  - **UtcDateAdded** (datetime) - Date the phone number was added to the blacklist (UTC)
  - **Comments** (string) - Comment for the blacklist entry
  - **Reason** (string) - Reason for adding the phone number to the blacklist, accepts values: CustomerAdded, SmsnenadoAdded
- **Total** (int32) - Total number of elements

#### Response Example
{
  "Items": [
    {
      "PhoneNumber": "+1234567890",
      "UtcDateAdded": "2023-10-27T10:00:00Z",
      "Comments": "Spam caller",
      "Reason": "CustomerAdded"
    }
  ],
  "Total": 1
}
```

--------------------------------

### POST /subAccounts/{login}

Source: https://www.mail365.ru/api.php

Updates details of an existing subaccount. Path parameters specify the login, and the request body contains the fields to be updated.

```APIDOC
## POST /subAccounts/{login}

### Description
Updates details of an existing subaccount. Path parameters specify the login, and the request body contains the fields to be updated.

### Method
POST

### Endpoint
/subAccounts/{login}

### Parameters
#### Path Parameters
- **login** (string) - Логин субаккаунта

#### Query Parameters
- **apiKey** (string) - api-Ключ

#### Request Body
- **Email** (string) - Email-адрес субаккаунта
- **Password** (string) - Пароль субаккаунта
- **FullName** (string) - Полное имя пользователя субаккаунта
- **AccessRights** (string[]) - Права доступа (EditContact, SmsSending, EmailSending, SingleSmsSending, EditContactGroup)
- **Position** (string) - Должность

### Request Example
```json
{
  "Email": "updated_email@example.com",
  "FullName": "Updated Sub Account Name",
  "AccessRights": ["SmsSending"],
  "Position": "Senior Manager"
}
```

### Response
#### Success Response (200)
- **Login** (string) - Логин
- **FullName** (string) - Полное имя
- **Email** (string) - Email-адрес
- **Position** (string) - Должность
- **AccessRights** (string[]) - Права доступа (EditContact, SmsSending, EmailSending, SingleSmsSending, EditContactGroup)
- **IsBlocked** (boolean) - True — если субаккаунт заблокирован

#### Response Example
```json
{
  "Login": "subaccount_login",
  "FullName": "Updated Sub Account Name",
  "Email": "updated_email@example.com",
  "Position": "Senior Manager",
  "AccessRights": ["SmsSending"],
  "IsBlocked": false
}
```
```

--------------------------------

### GET /singleSms/{id}

Source: https://www.mail365.ru/api.php

Retrieves information about a specific single SMS message using its ID.

```APIDOC
## GET /singleSms/{id}

### Description
Retrieves information about a specific single SMS message using its ID.

### Method
GET

### Endpoint
/singleSms/{id}

### Parameters
#### Path Parameters
- **Id** (string) - Required - The unique identifier of the single SMS message. This ID can be obtained from the GET: /singleSms method.

#### Query Parameters
- **apiKey** (string) - Required - Your API key.

### Response
#### Success Response (200)
- **Id** (string) - The SMS message identifier.
- **PlannedUtcDateTime** (datetime) - The planned sending time in UTC.
- **DeliveryUtcDateTime** (datetime) - The delivery time in UTC, can be null.
- **Status** (string) - The delivery status. Possible values: Enroute, Delivered, Undeliverable.
- **SenderId** (string) - The sender ID.
- **PhoneNumber** (string) - The recipient's phone number.
- **Cost** (decimal) - The cost of sending in rubles.
- **Text** (string) - The SMS text.

#### Response Example
```json
{
  "Id": "sms-12345",
  "PlannedUtcDateTime": "2023-10-27T10:00:00Z",
  "DeliveryUtcDateTime": "2023-10-27T10:05:00Z",
  "Status": "Delivered",
  "SenderId": "MySender",
  "PhoneNumber": "+1234567890",
  "Cost": 0.5,
  "Text": "Hello from Mail365!"
}
```
```

--------------------------------

### GET /contacts/{id}

Source: https://www.mail365.ru/api.php

Retrieves detailed information about a specific contact using its unique identifier.

```APIDOC
## GET /contacts/{id}

### Description
Retrieves detailed information about a specific contact using its unique identifier.

### Method
GET

### Endpoint
/contacts/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The identifier of the contact. This can be obtained using the GET: /contactGroups/{id}/contacts method.

#### Query Parameters
- **apiKey** (string) - Required - Your API key.

### Response
#### Success Response (200)
- **Data** (string[]) - The contact record details (name, surname, phone number, etc.).
- **PhoneNumberInBlackList** (boolean) - True if the phone number is in the blacklist.
- **EmailInBlackList** (boolean) - True if the email address is in the blacklist.
- **Id** (string) - The contact's identifier.

#### Response Example
```json
{
  "Data": {
    "Номер телефона": "88005551745",
    "Название": "Арамба",
    "Комментарий": "Лучший сервис для СМС и email информирования"
  },
  "PhoneNumberInBlackList": false,
  "EmailInBlackList": false,
  "Id": "contact_123"
}
```
```
Tokens:
Raw