Управление группами получателей

Как создать группу получателей

     Пример json данных для запроса:

{
  "title":"My Recipients"
}


 
Пример самого HTTP запроса:

curl -X POST https://api.msndr.net/v1/email/lists \
     -H 'Content-Type: application/json'     \
     -H 'Authorization: Bearer $API_TOKEN'   \
     -d '...JSON...'


Здесь используется метод POST и ссылка /email/lists

Пример ответа в случае если запрос прошёл успешно:

{
  "id":1,
  "title":"My Recipients"
}


Рассмотри параметры запроса. Ниже представлено информация по этим параметрам: название, описание и является ли этот параметр обязательным

Параметр

Описание

Обязательный

title

Название группы получателей. Должно быть уникальным

Да

Рассмотрим имя и описание атрибутов json ответа сервера:

Атрибут

Описание

id

Идентификатор созданной группы

title

Название группы

Получение списка групп

Пример HTTP запроса следующий:

curl -X GET https://api.msndr.net/v1/email/lists \
     -H 'Content-Type: application/json'    \
     -H 'Authorization: Bearer $API_TOKEN'


Здесь используется метод GET и ссылка /email/lists
Данный метод поддерживает постраничный вывод.
Если запрос будет выполнен успешно вы получите следующий json ответ:

{
  "total_count":3,
  "total_pages":1,
  "page_number":1,
  "page_size":25,
  "collection":[
    {
      "id":1,
      "title":"My Recipients"
    },
    {
      "id":2,
      "title":"My Recipients #2"
    },
    {
      "id":3,
      "title":"My Recipients #3"
    }
  ]
}


Ответ содержит коллекцию групп получателей. Каждый элемент которой имеет следующие параметры:

Атрибут

Описание

id

Идентификатор группы

title

Название группы

Получение информации о группе


Пример http запроса:

curl -X GET https://api.msndr.net/v1/email/lists/1 \
     -H 'Content-Type: application/json'      \
     -H 'Authorization: Bearer $API_TOKEN'


Здесь используется метод GET и ссылка /email/lists/:id
где :id - идентификатор группы для запроса информации.
Пример ответа в случае успеха

{
  "id":1,
  "title":"My Recipients"
}


Приведём описание атрибутов в json ответе сервера:

Атрибут

Описание

id

Идентификатор группы

title

Название группы

Удаление группы 

Пример HTTP запроса:

curl -X DELETE https://api.msndr.net/v1/email/lists/1 \
     -H 'Content-Type: application/json'         \
     -H 'Authorization: Bearer $API_TOKEN'
 

Здесь используется метод DELETE и ссылка /email/lists/:id

 

где :id - идентификатор группы для запроса информации

 

В случае успешного удаления сервер вернет пустой ответ со статусом 204.

 

Редактирование группы

 

Пример json данных для запроса:

{
  "title":"New Title"
}


 

Пример HTTP запроса:

 

curl -X PATCH https://api.msndr.net/v1/email/lists/1 \
     -H 'Content-Type: application/json'        \
     -H 'Authorization: Bearer $API_TOKEN'
     -d '...JSON...'


Здесь используется метод PATCH и ссылка /email/lists/:id

 

где :id - идентификатор группы для запроса информации

 

Пример ответа в случае успешного вопроса

{
  "id":1,
  "title":"New Title"
}


 

Ниже приведена таблица с описанием параметров HTTP запроса:

Параметр

Описание

Обязательный

title

Название группы получателей. Должно быть уникальным

Да

 

Ниже приведена таблица с описанием атрибутов json ответа от сервера:

Атрибут

Описание

id

Идентификатор созданной группы

title

Название группы

 

  • 40 Пользователи нашли это полезным
Помог ли вам данный ответ?

Связанные статьи

Управление параметрами групп получателей

Создание параметра группы Пример json данных для HTTP запроса: { "title":"Age", "kind":...

Общие сведения

Через программный интерфейс (далее - API) сервиса email рассылок можно отправлять рассылки,...

Ограничения вводимые сервисом для предотвращения спам рассылки

Для предотвращения спам рассылки , предусмотрен механизм ограничения числа отправлений. В личном...

Получение текущего баланса

Чтобы получить информацию по вашему балансу нужно выполнить следующий HTTP запрос: curl -X GET...

Отправка одного сообщения

Отправка одного email сообщения Пример json данных для запроса: {...