Students

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

post
Create

https://{subdomain}.inskill.ru/api/v3/students
Добавление нового ученика в проект.
Request
Response
Request
Path Parameters
subdomain
required
string
Уникальный поддомен вашего проекта
Form Data Parameters
notify_about_product
optional
boolean
Если true, то при добавлении продукта, клиенту будет отправлено письмо о новом продукте (содержимое письма задается в настройках проекта).
email
required
string
Email пользователя
name
optional
string
ФИО пользователя
phone
optional
string
Номер телефона в международном формате E.164. Пример: +79123456789
product
optional
integer
ID продукта, который необходимо назначить пользователю после добавления. ID продукта можно взять на странице "Моя страница" в личном кабинете администратора.
force
optional
boolean
Если клиент уже есть в проекте, то он будет обновлен.
Response
200: OK
Возвращает данные созданного пользователя
{
"data": {
"id": 2131,
"name": "Prof. Golden Wintheiser",
"email": "[email protected]",
"phone": "+18657085469952",
"avatar": ""
},
"status": "ok",
"message": "Пользователь успешно добавлен"
}
422: Unprocessable Entity
Ошибка валидации: пользователь уже добавлен
{
"data": {
"id": 2131,
"name": "Prof. Golden Wintheiser",
"email": "[email protected]",
"phone": "+18657085469952",
"avatar": ""
},
"message": "The given data was invalid.",
"errors": {
"email": [ "Пользователь с таким email уже присутствует в проекте. Воспользуйтесь методом Update для обновления пользователя." ]
}
}

Для ученика будет создан случайный пароль и отправлено приветственное письмо.

Текст приветственного письма можно задать в настройках проекта.

patch
Update

https://{subdomain}.inskill.ru/api/v3/students/{student}
Обновление имеющегося ученика
Request
Response
Request
Path Parameters
student
required
integer
Уникальный ID ученика. ID ученика может быть получен в личном кабинете администратора, или при создании ученика через API
subdomain
required
string
Уникальный поддомен вашего проекта
Body Parameters
phone
optional
string
Телефон ученика в международном формате E.164. Пример: +79123456789
name
optional
string
ФИО ученика
product
optional
integer
ID продукта, который необходимо назначить пользователю. ID продукта можно взять на странице "Моя страница" в личном кабинете администратора.
Response
200: OK
{
"data": {
"id": 1324,
"name": "Prof. Golden Hugo",
"email": "[email protected]",
"phone": "+18126388729",
"avatar": ""
},
"status": "ok",
"message": "Пользователь успешно обновлен"
}