Списки
С помощью API вы можете создавать, редактировать и удалять списки подписчиков.

Получение списков

Отправьте GET запрос на URL http://api.mailhandler.ru/sub/lists/. Запрос не должен содержать параметров. В результате вы получите ответ в формате JSON со списком созданных вами списков.
Bash
Python
Пример получения списка объектов с помощью curl:
curl 'http://api.mailhandler.ru/sub/lists/' \
-X GET \ -H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-H 'X-Secure-Token: <YOUR_TOKEN>'
Пример получения списка объектов на python:
import requests
def get_list():
headers = {
'X-Secure-Token': '<YOUR_TOKEN>',
'Accept': 'application/json',
'Content-Type': 'application/json',
}
response = requests.get('http://api.mailhandler.ru/sub/lists/',
json=data,
headers=headers)
print(response.status_code)
В случае успешного выполнения запроса вы получите ответ в формате JSON со статусом 200 OK
{
"count": 1,
"next": null,
"previous": null,
"results": [
{
"id": 436,
"name": "Подписавшиеся на новости",
"email_reason": "Вы получили это письмо, поскольку подписались на наши обновления на сайте www.mailhandler.ru",
"active_subscribers_count": 0,
"inactive_subscribers_count": 0,
"overall_subscribers_count": 0,
"date_created": "2017-03-15T10:21:56.854530"
}]
}

Создание списка

Отправьте POST запрос на URL http://api.mailhandler.ru/sub/lists/. Запрос должен содержать следующие параметры:
Название
Описание
Обязателен
Пример
name
Название списка
Да
Подписавшиеся на новости
email_reason
Причина получения писем
Да
Вы получили это письмо, поскольку подписались на наши обновления на сайте www.mailhandler.ru
В результате успешного создания объекта вы получите ответ в формате JSON с данными созданного объекта:
Название
Описание
Пример
id
Идентификатор списка
100
name
Название
Подписавшиеся на новости
email_reason
Причина получения писем
Вы получили это письмо, поскольку подписались на наши обновления на сайте www.mailhandler.ru
active_subscribers_count
Число активных подписчиков
100
inactive_subscribers_count
Число неактивных подписчиков
5
overall_subscribers_count
Общее число подписчиков
105
date_created
Дата создания списка
2017-03-15T10:21:56.854530
Bash
Python
Пример создания объекта с помощью curl:
curl 'http://api.mailhandler.ru/sub/lists/' \
-X POST \ -H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-H 'X-Secure-Token: <YOUR_TOKEN>' \
-d '{"name":"Подписавшиеся на новости", "email_reason":"Вы получили это письмо, поскольку подписались на наши обновления на сайте www.mailhandler.ru"}'
Пример создания объекта на python:
import requests
def create():
headers = {
'X-Secure-Token': '<YOUR_TOKEN>',
'Accept': 'application/json',
'Content-Type': 'application/json',
}
data = {
'name': 'Подписавшиеся на новости',
'email_reason': 'Вы получили это письмо, поскольку подписались на наши обновления на сайте www.mailhandler.ru'
}
response = requests.post('http://api.mailhandler.ru/sub/lists/',
json=data,
headers=headers)
print(response.status_code)
В случае успешного создания объекта вы получите ответ в формате JSON со статусом 201 Created
{
"id": 436,
"name": "Подписавшиеся на новости",
"email_reason": "Вы получили это письмо, поскольку подписались на наши обновления на сайте www.mailhandler.ru",
"active_subscribers_count": 0,
"inactive_subscribers_count": 0,
"overall_subscribers_count": 0,
"date_created": "2017-03-15T10:21:56.854530"
}

Редактирование списка

Отправьте PUT или PATCH запрос на URL http://api.mailhandler.ru/sub/lists/{list_id}/, где list_id - идентификатор нужного вам списка.
Запрос может содержать следующие параметры:
Название
Описание
Обязателен
Пример
name
Название списка
Нет
Подписавшиеся на новости
email_reason
Причина получения писем
Нет
Вы получили это письмо, поскольку подписались на наши обновления на сайте www.mailhandler.ru
В результате успешного создания объекта вы получите ответ в формате JSON с данными отредактированного объекта:
Название
Описание
Пример
id
Идентификатор списка
100
name
Название
Подписавшиеся на новости
email_reason
Причина получения писем
Вы получили это письмо, поскольку подписались на наши обновления на сайте www.mailhandler.ru
active_subscribers_count
Число активных подписчиков
100
inactive_subscribers_count
Число неактивных подписчиков
5
overall_subscribers_count
Общее число подписчиков
105
date_created
Дата создания списка
2017-03-15T10:21:56.854530
Bash
Python
Пример редактирования объекта с помощью curl:
curl 'http://api.mailhandler.ru/sub/lists/100' \
-X PATCH \ -H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-H 'X-Secure-Token: <YOUR_TOKEN>' \
-d '{"name":"Подписавшиеся на новости"}'
Пример редактирования объекта на python:
import requests
def edit():
headers = {
'X-Secure-Token': '<YOUR_TOKEN>',
'Accept': 'application/json',
'Content-Type': 'application/json',
}
data = {
'name': 'Подписавшиеся на новости'
}
response = requests.patch('http://api.mailhandler.ru/sub/lists/100/',
json=data,
headers=headers)
print(response.status_code)
В случае успешного изменения объекта вы получите ответ в формате JSON со статусом 200 OK
{
"id": 100,
"name": "Подписавшиеся на новости",
"email_reason": "Вы получили это письмо, поскольку подписались на наши обновления на сайте www.mailhandler.ru",
"active_subscribers_count": 0,
"inactive_subscribers_count": 0,
"overall_subscribers_count": 0,
"date_created": "2017-03-15T10:21:56.854530"
}

Получение данных списка

Отправьте GET запрос на URL http://api.mailhandler.ru/sub/lists/{list_id}/, где list_id - идентификатор нужного вам списка.
Запрос не должен содержать параметров.
В результате успешного запроса вы получите ответ в формате JSON с данными отредактированного объекта:
Название
Описание
Пример
id
Идентификатор списка
100
name
Название
Подписавшиеся на новости
email_reason
Причина получения писем
Вы получили это письмо, поскольку подписались на наши обновления на сайте www.mailhandler.ru
active_subscribers_count
Число активных подписчиков
100
inactive_subscribers_count
Число неактивных подписчиков
5
overall_subscribers_count
Общее число подписчиков
105
date_created
Дата создания списка
2017-03-15T10:21:56.854530
Bash
Python
Пример получения данных объекта с помощью curl:
curl 'http://api.mailhandler.ru/sub/lists/100' \
-X GET \ -H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-H 'X-Secure-Token: <YOUR_TOKEN>'
Пример получения данных объекта на python:
import requests
def get():
headers = {
'X-Secure-Token': '<YOUR_TOKEN>',
'Accept': 'application/json',
'Content-Type': 'application/json',
}
response = requests.get('http://api.mailhandler.ru/sub/lists/100/',
headers=headers)
print(response.status_code)
В случае успешного получения данных объекта вы получите ответ в формате JSON со статусом 200 OK
{
"id": 100,
"name": "Подписавшиеся на новости",
"email_reason": "Вы получили это письмо, поскольку подписались на наши обновления на сайте www.mailhandler.ru",
"active_subscribers_count": 0,
"inactive_subscribers_count": 0,
"overall_subscribers_count": 0,
"date_created": "2017-03-15T10:21:56.854530"
}

Удаление списка

Отправьте DELETE запрос на URL http://api.mailhandler.ru/sub/lists/{list_id}/, где list_id - идентификатор нужного вам списка.
Запрос не должен содержать параметров.
В результате успешного запроса вы получите ответ со статусом 204 No Content.
Bash
Python
Пример удаления списка с помощью curl:
curl 'http://api.mailhandler.ru/sub/lists/100' \
-X DELETE \ -H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-H 'X-Secure-Token: <YOUR_TOKEN>'
Пример удаления объекта на python:
import requests
def delete():
headers = {
'X-Secure-Token': '<YOUR_TOKEN>',
'Accept': 'application/json',
'Content-Type': 'application/json',
}
response = requests.delete('http://api.mailhandler.ru/sub/lists/100/',
headers=headers)
print(response.status_code)