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

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

Отправьте GET запрос на URL http://api.mailhandler.ru/sub/lists/{list_id}/subscribers/, где list_id - идентификатор нужного вам списка.
Вы можете осуществлять фильтрацию подписчиков по следующим параметрам:
Название
Описание
Обязателен
Пример
email
Email
Нет
email__icontains=ivanov - осуществит поиск подписчиков, адрес которых содержит строку ivanov, [email protected] - осуществит поиск подписчика, адрес которого совпадает с [email protected]
is_active
False/True, активный или нет
Нет
is_active=False
В результате вы получите ответ в формате JSON со списком созданных вами подписчиков.
Bash
Python
Пример получения списка объектов с помощью curl:
1
curl 'http://api.mailhandler.ru/sub/lists/100/subscribers/' \
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/100/subscribers/',
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
"id": 688072,
7
"list_id": 100,
8
"email": "[email protected]",
9
"name": "",
10
"is_active": true,
11
"disable_reason": null,
12
"is_email_verified": false,
13
"meta": {},
14
"source": "API",
15
"opt_in_signed": null,
16
"date_created": "2017-02-28T23:16:26.203756"
17
}]
18
}
Copied!

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

Отправьте POST запрос на URL http://api.mailhandler.ru/sub/lists/{list_id}/subscribers/. Запрос может содержать следующие параметры:
Название
Описание
Обязателен
Пример
email
Email
Да
name
Имя подписчика
Нет
Дмитрий
meta
Дополнительные данные подписчика в формате JSON. Ключи в структуре обязательно должны совпадать с названиями дополнительных переменных вашего списка
Нет
"{\"surname\": \"Иванов\"}"
is_active
bool, активный или нет, по умолчанию true
Нет
false
В результате успешного создания объекта вы получите ответ в формате JSON с данными созданного объекта:
Название
Описание
Пример
id
Идентификатор объекта
100
list_id
Идентификатор списка
1
name
Имя
Дмитрий
is_active
Активный или нет
true
disable_reason
Причина выключения
UNSUBSCRIBED
is_email_verified
Подтвержден email или нет
false
meta
Дополнительные данные подписчика. Структура в формате JSON.
{"surname":"Иванов"}
source
Источник. Возможные значения: IMPORT, FORM, API, APP
IMPORT
opt_in_signed
Дата подписки Opt-In, может быть null
2017-03-15T10:21:56.854530
date_created
Дата добавления
2017-03-15T10:21:56.854530
Bash
Python
Пример создания объекта с помощью curl:
1
curl 'http://api.mailhandler.ru/sub/lists/100/subscribers/' \
2
-X POST \ -H 'Accept: application/json' \
3
-H 'Content-Type: application/json' \
4
-H 'X-Secure-Token: <YOUR_TOKEN>' \
5
-d '{"email":"[email protected]"}'
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
'email': '[email protected]'
11
}
12
response = requests.post('http://api.mailhandler.ru/sub/lists/100/subscribers/',
13
json=data,
14
headers=headers)
15
print(response.status_code)
Copied!
В случае успешного создания объекта вы получите ответ в формате JSON со статусом 201 Created
1
{
2
"id": 688072,
3
"list_id": 100,
4
"email": "[email protected]",
5
"name": "",
6
"is_active": true,
7
"disable_reason": null,
8
"is_email_verified": false,
9
"meta": {},
10
"source": "API",
11
"opt_in_signed": null,
12
"date_created": "2017-02-28T23:16:26.203756"
13
}
Copied!

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

Отправьте PUT или PATCH запрос на URL http://api.mailhandler.ru/sub/lists/{list_id}/subscribers/{subscriber_id}/, где list_id - идентификатор нужного вам списка, subscriber_id - идентификатор нужного вам подписчика.
Запрос может содержать следующие параметры:
Название
Описание
Обязателен
Пример
email
Email
Да
name
Имя подписчика
Нет
Дмитрий
meta
Дополнительные данные подписчика в формате JSON. Ключи в структуре обязательно должны совпадать с названиями дополнительных переменных вашего списка
Нет
"{\"surname\": \"Иванов\"}"
is_active
bool, активный или нет, по умолчанию true
Нет
false
В результате успешного создания объекта вы получите ответ в формате JSON с данными отредактированного подписчика:
Название
Описание
Пример
id
Идентификатор объекта
100
list_id
Идентификатор списка
1
name
Имя
Дмитрий
is_active
Активный или нет
true
disable_reason
Причина выключения
UNSUBSCRIBED
is_email_verified
Подтвержден email или нет
false
meta
Дополнительные данные подписчика. Структура в формате JSON.
{"surname":"Иванов"}
source
Источник. Возможные значения: IMPORT, FORM, API, APP
IMPORT
opt_in_signed
Дата подписки Opt-In, может быть null
2017-03-15T10:21:56.854530
date_created
Дата добавления
2017-03-15T10:21:56.854530
Bash
Python
Пример редактирования объекта с помощью curl:
1
curl 'http://api.mailhandler.ru/sub/lists/100/subscribers/500/' \
2
-X PATCH \ -H 'Accept: application/json' \
3
-H 'Content-Type: application/json' \
4
-H 'X-Secure-Token: <YOUR_TOKEN>' \
5
-d '{"email":"[email protected]"}'
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
'email': '[email protected]'
11
}
12
response = requests.patch('http://api.mailhandler.ru/sub/lists/100/subscribers/500/',
13
json=data,
14
headers=headers)
15
print(response.status_code)
Copied!
В случае успешного редактирования объекта вы получите ответ в формате JSON со статусом 200 OK
1
{
2
"id": 688072,
3
"list_id": 100,
4
"email": "[email protected]",
5
"name": "",
6
"is_active": true,
7
"disable_reason": null,
8
"is_email_verified": false,
9
"meta": {},
10
"source": "API",
11
"opt_in_signed": null,
12
"date_created": "2017-02-28T23:16:26.203756"
13
}
Copied!

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

Отправьте GET запрос на URL http://api.mailhandler.ru/sub/lists/{list_id}/subscribers/{subscriber_id}/, где list_id - идентификатор нужного вам списка, subscriber_id - идентификатор нужного вам подписчика.
Запрос не должен содержать параметров.
В результате успешного запроса вы получите ответ в формате JSON с данными объекта:
Название
Описание
Пример
id
Идентификатор объекта
100
list_id
Идентификатор списка
1
name
Имя
Дмитрий
is_active
Активный или нет
true
disable_reason
Причина выключения
UNSUBSCRIBED
is_email_verified
Подтвержден email или нет
false
meta
Дополнительные данные подписчика. Структура в формате JSON.
{"surname":"Иванов"}
source
Источник. Возможные значения: IMPORT, FORM, API, APP
IMPORT
opt_in_signed
Дата подписки Opt-In, может быть null
2017-03-15T10:21:56.854530
date_created
Дата добавления
2017-03-15T10:21:56.854530
Bash
Python
Пример получения данных объекта с помощью curl:
1
curl 'http://api.mailhandler.ru/sub/lists/100/subscribers/500/' \
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/subscribers/500/',
10
headers=headers)
11
print(response.status_code)
Copied!
В случае успешного получения данных объекта вы получите ответ в формате JSON со статусом 200 OK
1
{
2
"id": 688072,
3
"list_id": 100,
4
"email": "[email protected]",
5
"name": "",
6
"is_active": true,
7
"disable_reason": null,
8
"is_email_verified": false,
9
"meta": {},
10
"source": "API",
11
"opt_in_signed": null,
12
"date_created": "2017-02-28T23:16:26.203756"
13
}
Copied!

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

Отправьте DELETE запрос на URL http://api.mailhandler.ru/sub/lists/{list_id}/subscribers/{subscriber_id}/, где list_id - идентификатор нужного вам списка, subscriber_id - идентификатор нужного вам подписчика.
Запрос не должен содержать параметров.
В результате успешного запрос вы получите ответ со статусом 204 No Content.
Bash
Python
Пример удаления объекта с помощью curl:
1
curl 'http://api.mailhandler.ru/sub/lists/100/subscribers/500/' \
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/subscribers/500/',
10
headers=headers)
11
print(response.status_code)
Copied!
Last modified 2yr ago