Все коллекции
API и Webhooks
Организация
Удалить сотрудника из Организации
Удалить сотрудника из Организации

POST /membership/{membershipId}/delete

Обновлено больше недели назад

В разделе описан запрос удаления сотрудника из организации.

Получить идентификаторы сотрудников можно с помощью запроса, в параметре "membershipId".

МЕТОД HTTP

POST

URL

ОБЯЗАТЕЛЬНЫЕ ПАРАМЕТРЫ

  • membershipId — идентификатор удаляемого сотрудника из организации

ДОПОЛНИТЕЛЬНЫЕ ПАРАМЕТРЫ

По умолчанию данные удаляемого сотрудника остаются ему в личном кабинете. Если необходимо удалить сотрудника и при этом передать его данные кому-нибудь другому в организации, то потребуется указать параметр:

  • destinationMembershipId — идентификатор сотрудника, которому переносятся данные от удаляемого.

СОСТОЯНИЯ ОТВЕТОВ:

204 No Content

  • Запрос успешно выполнен

400 Bad Request

  • "message": "Can not normalize the option \"destinationMembershipId\" with value \"\" into \"int\"" — destinationMembershipId не соответствует формату идентификаторов;

  • "message": "Organization destination membership not found" — Сотрудника с указанным destinationMembershipId нет в организации.

401 Unauthorized

  • Ключ userapi не передан, или является недействительным.

403 Forbidden

  • "message": "No userapi access" — В тарифе нет возможности работы с userapi;

  • "message": "A user with the \"STUDENT\" type is not supported" — Текущий тип пользователя не поддерживается.

404 Not Found

  • "message": "Organization membership not found" — Удаляемого сотрудника (membershipId) в организации не найдено.

ПРИМЕР ЗАПРОСА

url: https://userapi.webinar.ru/v3/membership/111111/delete,
method: POST,
headers:
{
x-auth-token: {Token},
Content-Type: application/x-www-form-urlencoded
};
body:
{
destinationMembershipId: 000000,
};

ПРИМЕР ОТВЕТА

204 No Content
Нашли ответ на свой вопрос?