Перейти к основному содержимому

UpdateSubscriptions

к сведению

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

Изменяет подписки сотрудника организации на почтовые уведомления.

POST /UpdateSubscriptions

Параметры запроса

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

Заголовки запроса

Тело запроса

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

Коды ответа

  • 200 — операция успешно завершена.
  • 400 — данные в запросе имеют неверный формат или отсутствуют обязательные параметры.
  • 401 — в запросе отсутствует HTTP-заголовок Authorization или в этом заголовке содержатся некорректные авторизационные данные.
  • 402 — у указанного ящика закончилась подписка на API.
  • 403 — доступ к ящику с предоставленным авторизационным токеном запрещен или запрос сделан не от имени администратора и не от имени пользователя, подписки которого редактируются.
  • 404 — в указанном ящике нет пользователя с указанным идентификатором.
  • 405 — используется неподходящий HTTP-метод.
  • 415 — тип содержимого запроса не поддерживается.
  • 429 — превышено ограничение на количество запросов в единицу времени.
  • 500 — при обработке запроса возникла непредвиденная ошибка.

Тело ответа

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

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

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

Подписка на уведомления о новых входящих документах и отписка от новостей Диадока:

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

POST /UpdateSubscriptions?boxId={{boxId}}&userId={{userId}} HTTP/1.1
Host: diadoc-api.kontur.ru
Authorization: Bearer {{access_token}}
Content-Type: application/json; charset=utf-8
Accept: application/json

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

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

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

{
"Subscriptions": [
{
"Id": "News",
"IsSubscribed": false
},
{
"Id": "NewIncomingDocuments",
"IsSubscribed": true
},
{
"Id": "CounteragentInvitation",
"IsSubscribed": false
},
{
"Id": "CounteragentInvitationResponses",
"IsSubscribed": false
},
{
"Id": "CounteragentSignatures",
"IsSubscribed": false
},
{
"Id": "CounteragentSignatureDenials",
"IsSubscribed": false
},
{
"Id": "ResolutionRequests",
"IsSubscribed": false
},
{
"Id": "ResolutionResults",
"IsSubscribed": false
},
{
"Id": "EmployeeRequests",
"IsSubscribed": true
},
{
"Id": "ChatMessages",
"IsSubscribed": true
}
]
}

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

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

См. также

Инструкции:

Методы для работы с сотрудниками:

  • CreateEmployee — добавляет в организацию сотрудника с указанными реквизитами (доступно только администраторам ящика)
  • DeleteEmployee — удаляет сотрудника организации (доступно только администраторам ящика)
  • GetEmployee — возвращает данные сотрудника организации по указанному идентификатору (доступно только администраторам ящика)
  • GetEmployees — возвращает список сотрудников указанной организации (доступно только администраторам ящика)
  • GetEmployeesByExternalId — возвращает список сотрудников организации по идентификатору учетной записи в системе SSO-провайдера (доступно только администраторам ящика)
  • GetMyEmployee — возвращает данные сотрудника организации, от имени которого вызывается метод
  • GetSubscriptions — возвращает информацию о подписках сотрудника организации на почтовые уведомления
  • UpdateEmployee — изменяет данные сотрудника организации (доступно только администраторам ящика)
  • UpdateSubscriptions — изменяет подписки сотрудника организации на почтовые уведомления

Оцените материал страницы

Нашли ошибку или столкнулись с проблемой?

СКБ Контурс 1988 года