UpdateSubscriptions¶

Примечание

Вызов метода доступен только администраторам организации и пользователю, подписки которого редактируются.

POST /UpdateSubscriptions¶

Query Parameters:

boxId – идентификатор ящика организации.
userId – идентификатор пользователя.

Request Headers:

Authorization – данные, необходимые для авторизации.

Request Body:

Тело запроса должно содержать структуру SubscriptionsToUpdate.

Status Codes:

200 OK – операция успешно завершена.
400 Bad Request – данные в запросе имеют неверный формат или отсутствуют обязательные параметры.
401 Unauthorized – в запросе отсутствует HTTP-заголовок Authorization или в этом заголовке содержатся некорректные авторизационные данные.
402 Payment Required – у организации с указанным идентификатором boxId закончилась подписка на API.
403 Forbidden – доступ к ящику с предоставленным авторизационным токеном запрещен или запрос сделан не от имени администратора и не от имени пользователя, подписки которого редактируются.
404 Not Found – в указанном ящике нет пользователя с указанным идентификатором.
405 Method Not Allowed – используется неподходящий HTTP-метод.
500 Internal Server Error – при обработке запроса возникла непредвиденная ошибка.

Response Body:

Тело ответа содержит измененные подписки сотрудника организации, представленные структурой EmployeeSubscriptions.

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

Примеры использования¶

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

POST /UpdateSubscriptions?boxId=994cf191-8322-40eb-8d79-f1196f8ec357&userId=fccbb0a6-0700-4401-81a6-8a6a083e12e6 HTTP/1.1
Host: diadoc-api.kontur.ru
Authorization: DiadocAuth ddauth_api_client_id=key, ddauth_token=token
Content-Type: application/json; charset=utf-8

{
    "Subscriptions": [
        { "Id": "NewIncomingDocuments", "IsSubscribed": "true" },
        { "Id": "News", "IsSubscribed": "false" }
    ]
}

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

Пример запроса с использованием C# SDK:

api.UpdateSubscriptions(token, boxId, userId, new SubscriptionsToUpdate
    {
        Subscriptions =
        {
            new Subscription { Id = "NewIncomingDocuments", IsSubscribed = true },
            new Subscription { Id = "News", IsSubscribed = false },
        }
    });

Пример ответа:

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
    "Subscriptions": [
        { "Id": "CounteragentInvitation", "IsSubscribed": "false" },
        ...
        { "Id": "NewIncomingDocuments", "IsSubscribed": "true" },
        { "Id": "News", "IsSubscribed": "false" },
        ...
        { "Id": "ChatMessages", "IsSubscribed": "true" }
    ]
}

В ответе будет состояние всех подписок сотрудника на почтовые уведомления.