Списки

С помощью API вы можете создавать, редактировать и удалять списки подписчиков.
Базовый URL: http://api.mailhandler.ru/sub/lists/​
Получение списков
Отправьте GET запрос на URL http://api.mailhandler.ru/sub/lists/. Запрос не должен содержать параметров. В результате вы получите ответ в формате JSON со списком созданных вами списков.
Bash
Python
Пример получения списка объектов с помощью curl:
1
curl 'http://api.mailhandler.ru/sub/lists/' \ 
2
-X GET \ -H 'Accept: application/json' \ 
3
-H 'Content-Type: application/json' \ 
4
-H 'X-Secure-Token: <YOUR_TOKEN>'
Copied!
Пример получения списка объектов на python:
1
import requests 
2
​
3
def get_list():     
4
    headers = {         
5
        'X-Secure-Token': '<YOUR_TOKEN>',         
6
        'Accept': 'application/json',         
7
        'Content-Type': 'application/json',     
8
    }      
9
    response = requests.get('http://api.mailhandler.ru/sub/lists/',                              
10
                  json=data, 
11
                  headers=headers)     
12
    print(response.status_code)
Copied!
В случае успешного выполнения запроса вы получите ответ в формате JSON со статусом 200 OK
1
{
2
  "count": 1,
3
  "next": null,
4
  "previous": null,
5
  "results": [
6
    {
7
      "id": 436,
8
      "name": "Подписавшиеся на новости",
9
      "email_reason": "Вы получили это письмо, поскольку подписались на наши обновления на сайте www.mailhandler.ru",
10
      "active_subscribers_count": 0,
11
      "inactive_subscribers_count": 0,
12
      "overall_subscribers_count": 0,
13
      "date_created": "2017-03-15T10:21:56.854530"
14
    }]
15
}
Copied!
Создание списка
Отправьте 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:
1
curl 'http://api.mailhandler.ru/sub/lists/' \ 
2
-X POST \ -H 'Accept: application/json' \ 
3
-H 'Content-Type: application/json' \ 
4
-H 'X-Secure-Token: <YOUR_TOKEN>' \ 
5
-d '{"name":"Подписавшиеся на новости", "email_reason":"Вы получили это письмо, поскольку подписались на наши обновления на сайте www.mailhandler.ru"}'
Copied!
Пример создания объекта на python:
1
import requests 
2
​
3
def create():     
4
    headers = {         
5
        'X-Secure-Token': '<YOUR_TOKEN>',         
6
        'Accept': 'application/json',         
7
        'Content-Type': 'application/json',     
8
    }     
9
    data = {         
10
        'name': 'Подписавшиеся на новости',         
11
        'email_reason': 'Вы получили это письмо, поскольку подписались на наши обновления на сайте www.mailhandler.ru'
12
    }     
13
    response = requests.post('http://api.mailhandler.ru/sub/lists/',                              
14
                  json=data, 
15
                  headers=headers)     
16
    print(response.status_code)
Copied!
В случае успешного создания объекта вы получите ответ в формате JSON со статусом 201 Created
1
{
2
      "id": 436,
3
      "name": "Подписавшиеся на новости",
4
      "email_reason": "Вы получили это письмо, поскольку подписались на наши обновления на сайте www.mailhandler.ru",
5
      "active_subscribers_count": 0,
6
      "inactive_subscribers_count": 0,
7
      "overall_subscribers_count": 0,
8
      "date_created": "2017-03-15T10:21:56.854530"
9
    }
Copied!
Редактирование списка
Отправьте 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:
1
curl 'http://api.mailhandler.ru/sub/lists/100' \ 
2
-X PATCH \ -H 'Accept: application/json' \ 
3
-H 'Content-Type: application/json' \ 
4
-H 'X-Secure-Token: <YOUR_TOKEN>' \ 
5
-d '{"name":"Подписавшиеся на новости"}'
Copied!
Пример редактирования объекта на python:
1
import requests 
2
​
3
def edit():     
4
    headers = {         
5
        'X-Secure-Token': '<YOUR_TOKEN>',         
6
        'Accept': 'application/json',         
7
        'Content-Type': 'application/json',     
8
    }     
9
    data = {         
10
        'name': 'Подписавшиеся на новости'
11
    }     
12
    response = requests.patch('http://api.mailhandler.ru/sub/lists/100/',                              
13
                  json=data, 
14
                  headers=headers)     
15
    print(response.status_code)
Copied!
В случае успешного изменения объекта вы получите ответ в формате JSON со статусом 200 OK
1
{
2
  "id": 100,
3
  "name": "Подписавшиеся на новости",
4
  "email_reason": "Вы получили это письмо, поскольку подписались на наши обновления на сайте www.mailhandler.ru",
5
  "active_subscribers_count": 0,
6
  "inactive_subscribers_count": 0,
7
  "overall_subscribers_count": 0,
8
  "date_created": "2017-03-15T10:21:56.854530"
9
}
Copied!
Получение данных списка
Отправьте 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:
1
curl 'http://api.mailhandler.ru/sub/lists/100' \ 
2
-X GET \ -H 'Accept: application/json' \ 
3
-H 'Content-Type: application/json' \ 
4
-H 'X-Secure-Token: <YOUR_TOKEN>'
Copied!
Пример получения данных объекта на python:
1
import requests 
2
​
3
def get():     
4
    headers = {         
5
        'X-Secure-Token': '<YOUR_TOKEN>',         
6
        'Accept': 'application/json',         
7
        'Content-Type': 'application/json',     
8
    }     
9
    response = requests.get('http://api.mailhandler.ru/sub/lists/100/',
10
                  headers=headers)     
11
    print(response.status_code)
Copied!
В случае успешного получения данных объекта вы получите ответ в формате JSON со статусом 200 OK
1
{
2
  "id": 100,
3
  "name": "Подписавшиеся на новости",
4
  "email_reason": "Вы получили это письмо, поскольку подписались на наши обновления на сайте www.mailhandler.ru",
5
  "active_subscribers_count": 0,
6
  "inactive_subscribers_count": 0,
7
  "overall_subscribers_count": 0,
8
  "date_created": "2017-03-15T10:21:56.854530"
9
}
Copied!
Удаление списка
Отправьте DELETE запрос на URL http://api.mailhandler.ru/sub/lists/{list_id}/, где list_id - идентификатор нужного вам списка.
Запрос не должен содержать параметров.
В результате успешного запроса вы получите ответ со статусом 204 No Content.
Bash
Python
Пример удаления списка с помощью curl:
1
curl 'http://api.mailhandler.ru/sub/lists/100' \ 
2
-X DELETE \ -H 'Accept: application/json' \ 
3
-H 'Content-Type: application/json' \ 
4
-H 'X-Secure-Token: <YOUR_TOKEN>'
Copied!
Пример удаления объекта на python:
1
import requests 
2
​
3
def delete():     
4
    headers = {         
5
        'X-Secure-Token': '<YOUR_TOKEN>',         
6
        'Accept': 'application/json',         
7
        'Content-Type': 'application/json',     
8
    }     
9
    response = requests.delete('http://api.mailhandler.ru/sub/lists/100/',
10
                  headers=headers)     
11
    print(response.status_code)
Copied!
Основная информация - Previous
Возможности API
Next - Подписчики
Дополнительные поля
Last modified 3yr ago
Copy link
Contents
Получение списков
Создание списка
Редактирование списка
Получение данных списка
Удаление списка