/v2/Api/Subscribers DELETE
Один подписчик может быть удален из всех листов или из одного определенного листа.
Формат запроса
По емейлу
Параметры запроса:
Параметры | Тип | Описание |
---|---|---|
apiKey | string | Ваш API-ключ, необходимый для авторизации. Обязательный. |
string | Емейл. Является параметром, а не частью адреса. Обязательный. Должен быть URL-encoded. | |
listId | int | Идентификатор листа. Необязательный. Если определен, то подписчик будет удален только из этого листа. Если нет, то из всех листов. |
Примеры:
https://api.esv2.com/v2/Api/Subscribers?apiKey=Ваш_API_ключ&email=johndoe@domain.com https://api.esv2.com/v2/Api/Subscribers?apiKey=Ваш_API_ключ&email=johndoe@domain.com&listId=1
По параметру ID
Параметры запроса:
Параметры | Тип | Описание |
---|---|---|
apiKey | string | Ваш API-ключ, необходимый для авторизации. Обязательный. |
ID | int | ID подписчика. Обязательный. Является частью адреса, а не параметром. Смотрите примеры. |
listId | int | Идентификатор листа. Необязательный. Если определен, то подписчик будет удален только из этого листа. Если нет, то из всех листов. |
Примеры:
https://api.esv2.com/v2/Api/Subscribers/123?apiKey=Ваш_API_ключ https://api.esv2.com/v2/Api/Subscribers/123?apiKey=Ваш_API_ключ&listId=1
Обратите внимание, что метод не удаляет подписчика из тестовых листов.
Примеры
Запрос:
DELETE https://api.esv2.com/v2/Api/Subscribers?apiKey=Ваш_API_ключ&email=john%40yahoo.com HTTP/1.1 Accept-Encoding: gzip,deflate User-Agent: Jakarta Commons-HttpClient/3.1 Host: api.esv2.com
Ответ:
HTTP/1.1 204 No Content Cache-Control: private Server: Microsoft-IIS/7.5 Set-Cookie: ASP.NET_SessionId=2ahrqf45zbbxc3njap11i155; path=/; HttpOnly X-AspNetMvc-Version: 1.0 X-AspNet-Version: 2.0.50727 X-Powered-By: ASP.NET Date: Wed, 07 Jul 2010 15:56:14 GMT
Формат ответа с ошибкой:
HTTP/1.1 404 Not Found Cache-Control: private Content-Type: text/xml; charset=utf-8 Server: Microsoft-IIS/7.5 Set-Cookie: ASP.NET_SessionId=uq4wknygxzgtyojyaxkl4myn; path=/; HttpOnly X-AspNetMvc-Version: 1.0 X-AspNet-Version: 2.0.50727 X-Powered-By: ASP.NET Date: Wed, 07 Jul 2010 16:11:18 GMT Content-Length: 264 <ApiResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <ErrorMessage> <Code>404</Code> <Message>No resources matching specified criteria were found.</Message> </ErrorMessage> </ApiResponse>