url: /mailer/forms
http-method: GET
Используется для получения списка форм подписки.
fields - значения по умолчанию: ["id","title"]. Список доступных полей: id, title, list_id, body. Если переданы неправильные параметры, вернётся значение по умолчанию.
HTTP status code: 200.
При успешном выполнении запроса метод возвращает запрашиваемые данные в формате json.
Пример успешного ответа:
{
"forms": [
{
"id": 1,
"title": "hello",
"list_id": 32,
"body": "some body"
}
]
}
| Название параметра | Тип | Описание |
|---|---|---|
| id | int | Идентификатор пользователя. |
| title | string | Название формы подписки. |
| list_id | int | Идентификатор группы подписчиков. |
| body | string | Тело формы. |
url: /mailer/forms/[id]
http-method: GET
Используется для получения формы по уникальному идентификатору (id).
fields - значение по умолчанию: ["id","title"]. Список доступных полей: id, title, body, list_id.
HTTP status code: 200.
При успешном выполнении запроса метод возвращает запрашиваемые данные в формате json.
Пример успешного ответа:
{
"id": 1,
"title": "title",
"body": "example",
"list_id": 13451
}
| Название параметра | Тип | Описание |
|---|---|---|
| id | int | Идентификатор формы. |
| title | string | Название формы. |
| body | string | Тело формы. |
| list_id | int | Идентификатор группы подписчиков. |
| Код ответа | Код ошибки | Текст ответа | Описание |
|---|---|---|---|
| 400 | 20720 | Invalid fields. Wrong parameters of string fields | Переданны неправильные параметры строки fields. |
| 404 | Not found | Формы по переданому идентификатору не найдено. |