Добавить сотрудников в организацию

С помощью запроса можно отправить приглашение сотрудникам на добавление в организацию. После этого сотрудникам необходимо подтвердить добавление в личном кабинете.

Важно! В одном запросе нельзя отправить более 30 приглашений.

МЕТОД HTTP

POST

URL

https://userapi.mts-link.ru/v3/organizations/invite-users

Важно! Отправлять запрос нужно в формате application/json.

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

Массив с данными о пользователях, которых нужно пригласить.

• email — почта сотрудника;

• name — имя;

• secondName — фамилия;

• phone — телефон;

• role — роль: сотрудник (LECTURER), или администратор (ADMIN). Посмотреть подробную информацию о правах, в зависимости от выбранной роли можно здесь.

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

• organizationName — название организации;

• position — должность;

• canDeleteEvent — возможность удаления сотрудником своих мероприятий, true, или false. По умолчанию false;

• viewEvents — доступ ко всем мероприятиям организации (просмотр), true, или false. По умолчанию false;

• viewFiles — доступ ко всем файлам организации(просмотр и удаление), true, или false. По умолчанию false;

• viewContacts — доступ ко всем контактам организации (просмотр), true, или false. По умолчанию false;

• organizationGroupId — id группы, куда присоединиться приглашаемый пользователь.

  Важно: список групп организации можно получить выполнив запрос GET /organization-groups (описание запроса по ссылке).

ПОЛЯ ОТВЕТА

В ответ передается массив данных по каждому пользователю с статусом приглашения:

• email — почта сотрудника;

• status — статус приглашения.

Статусы могут быть следующие:

• another_org — приглашаемый пользователь уже находится в другой организации;

• paid_tariff — у приглашаемого пользователя есть платный тариф. Соответственно добавить в текущую организацию пользователя с платным тарифом не получится;

• exist_already — пользователь уже находится в текущей организации;

• exist_invited — приглашение пользователю уже отправлено;

• free_limit_exceeded — превышен лимит приглашений в организацию;

• ok — приглашение пользователю успешно отправлено;

• group_not_belonging_organization — группа не принадлежит организации;

• group_not_found - группа не найдена.

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

url: https://userapi.mts-link.ru/v3/organizations/invite-users,
method: POST,
headers: 
{
    x-auth-token: {Token},
    Content-Type: application/json
},
data: 
{
  "invitations": [
    {
      "email": "email@mail.ru",
      "name": "Имя",
      "secondName": "Фамилия",
      "phone": "89999999999",
      "organizationName": "Webinar",
      "position": "Сотрудник",
      "role": "LECTURER",
      "canDeleteEvent": false,
      "viewEvents": false,
      "viewFiles": false,
      "viewContacts": false
    }
  ]
};

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

[
    {
        "email": "email@mail.ru",
        "status": "ok"
    }
]