Справка

Награды

Облачный Pyrus

С помощью Pyrus API можно автоматически присваивать и отзывать награды сотрудникам при достижении заданных порогов. Например, награда «Новичок» может автоматически присваиваться сотруднику в первый день работы, а затем автоматически сниматься через 365 дней, когда статус новичка уже неактуален. В этой статье описано, как использовать API для управления автоматическим вручением и отзывом наград.

PUT /awards/{id}/threshold

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

PUT https://api.pyrus.com/v4/awards/{id}/threshold

Тело запроса


{
  "grant_threshold": 1,
  "revoke_threshold": 91
}

Тело ответа


{
  "grant_threshold": 1,
  "revoke_threshold": 91
}

curl

curl -X PUT \
  https://api.pyrus.com/v4/awards/{id}/threshold \
  -H 'Authorization: Bearer <YOUR_ACCESS_TOKEN>' \
  -H 'Content-Type: application/json' \
  -d '{
  "grant_threshold": 1,
  "revoke_threshold": 91
}'

Параметры

grant_thresholdЦелое неотрицательное число. Значение счётчика, при достижении которого награда вручается. Чтобы отключить порог вручения, укажите 0.
revoke_thresholdЦелое неотрицательное число. Значение счётчика, при достижении которого награда отменяется. Чтобы отключить порог отмены, укажите 0. Если задан порог вручения, порог отмены должен быть больше этого значения.

Обратите внимание: если у сотрудника счётчик уже имел какое-либо значение до того, как вы изменили пороги награды, статус награды автоматически не изменится.

Например, награда «Новичок» отзывается при достижении счётчиком значения 365. После изменения порога отмены на 90 награда не будет снята немедленно, даже если текущее значение счётчика уже больше 90. Отзыв произойдёт только при следующем обновлении счётчика пользователя.

GET /awards/{id}/threshold

Метод возвращает текущие значения порога срабатывания и отмены награды по её ID.

GET https://api.pyrus.com/v4/awards/{id}/threshold

Тело ответа


{
	"grant_threshold": 0,
    "revoke_threshold": 0
}

curl

curl -X GET \
  https://api.pyrus.com/v4/awards/{id}/threshold \
  -H 'Authorization: Bearer <YOUR_ACCESS_TOKEN>'

GET /members/{member-id}/awards/{award-id}/counter

Метод возвращает текущее значение счётчика награды для конкретного пользователя.

GET https://api.pyrus.com/v4/members/{member-id}/awards/{award-id}/counter

Тело ответа


{
  "person_id": 1248278,
  "award_id": 1324,
  "award_counter": 0,
  "assignment_date": "2025-10-21T14:43:15Z"
}

curl

curl -X GET \
  https://api.pyrus.com/v4/members/{member-id}/awards/{award-id}/award_counter \
  -H 'Authorization: Bearer <YOUR_ACCESS_TOKEN>'

POST /members/{member-id}/awards/{award-id}/counter/increment

Метод увеличивает значение счётчика награды пользователя на 1. Если порог не задан, изменение счётчика пользователя не приведёт к вручению награды.

POST https://api.pyrus.com/v4/members/{member-id}/awards/{award-id}/counter/increment

Тело ответа

{
    "person_id": 1152811,
    "award_id": 1387,
    "award_counter": 2,
    "assignment_date": "2025-10-28T10:14:30Z"
}

curl


curl -X POST \
  https://api.pyrus.com/v4/members/{member-id}/awards/{award-id}/counter/increment \
  -H 'Authorization: Bearer <YOUR_ACCESS_TOKEN>'

PUT /members/{member-id}/awards/{award-id}/counter

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

PUT https://api.pyrus.com/v4/members/{member-id}/awards/{award-id}/counter?value={number}

Тело ответа

{
   "person_id": 1248278,
   "award_id": 1324,
   "award_counter": 100,
   "assignment_date": "2025-10-21T14:43:15Z"
}

curl

curl -X PUT \
  https://api.pyrus.com/v4/members/{member-id}/awards/{award-id}/counter?value=number \
  -H 'Authorization: Bearer <YOUR_ACCESS_TOKEN>'

Параметры

valueЧисло. Новое значение счётчика награды.

Была ли эта статья полезной?