Метод используется для отзыва приглашения пользователя, которое было создано в результате вызова метода Приглашение пользователя. Приглашение можно отозвать, если пользователь еще не успел его принять. В результате приглашенный пользователь получает статус Удален, а метод возвращает пустой ответ. Код ответа 204 No content. У текущего пользователя должен быть доступ к указанному аккаунту.
DELETE {reseller_domain}/internal_api/accounts/{account_id}/invited_users/{invited_user_id}
В этой статье:
Авторизация
Требуется авторизация с помощью access token пользователя.
Аргументы
|
Название |
Тип параметра |
Тип данных |
Обязательный/
|
Описание |
|---|---|---|---|---|
|
Content-Type |
header |
string |
Обязательный |
Тип данных, передаваемых в запросе. Укажите application/vnd.api+json |
|
Accept |
header |
string |
Обязательный |
Поддерживаемые типы данных в ответе. Укажите application/vnd.api+json |
|
X-Api-Locale |
header |
string |
Опциональный |
Двухбуквенный код языка данных в ответе |
|
Authorization |
header |
string |
Обязательный |
Действующий access token пользователя. Формат: |
|
reseller_domain |
path |
string |
Обязательный |
Доменное имя реселлера |
|
account_id |
path |
integer |
Обязательный |
ID аккаунта, от имени которого было отправлено приглашение |
|
invited_user_id |
path |
integer |
Обязательный |
ID приглашенного пользователя, для которого нужно отозвать приглашение (см. Получение списка приглашенных пользователей) |
Пример запроса
curl --location --request DELETE 'https://test.activeplatform.com/internal_api/accounts/1185/invited_users/299' \
--header 'Content-Type: application/vnd.api+json' \
--header 'Accept: application/vnd.api+json' \
--header 'X-Api-Locale: en' \
--header 'Authorization: Bearer AccessTokenExample'