Выдать бонусы

Запрос
Заголовки
Query-параметры
Тело запроса
Ответ

Важно

Домен toloka.yandex.com работает в режиме deprecated. Рекомендуем переключиться на домен toloka.dev для запросов API.

Выдает бонусы исполнителям.

Сумма бонуса может составлять от 0,001 до 100 долларов одному исполнителю единовременно.

Внимание

Вы можете отправить не более 10 000 таких запросов в день.

В одном запросе нельзя передавать одному толокеру несколько бонусов с одинаковой ценой, названием и сообщением. Будет возвращен ответ со статусом 409.

Пример ошибки c HTTP статусом 409

{
  "user_id": {
    "code": "ENTITY_CONFLICT",
    "message": "It is not allowed to apply multiple bonuses with the same amount, title, message and comment to same user in single operation"
  }
}

Запрос

Боевая версия

Песочница

POST https://toloka.dev/api/v1/user-bonuses
Authorization: OAuth <OAuth token>
Content-Type: application/JSON

POST https://sandbox.toloka.dev/api/v1/user-bonuses
Authorization: OAuth <OAuth token>
Content-Type: application/JSON

Заголовки

Заголовок	Описание
Authorization	Токен для авторизации аккаунта. В качестве префикса добавьте OAuth.
Content-Type	Указывает формат данных в передаваемом теле запроса.

Query-параметры

Указываются в ссылке после знака вопроса, перечисляются через &.

Параметр	Описание
async_mode	boolean Способ обработки запроса: `true` — отложенный. В результате запроса создается асинхронная операция, выполняемая в фоновом режиме. Ответ содержит сведения об операции (время начала и окончания, статус, количество бонусов). `false` — синхронный. Ответ содержит сведения о выданных бонусах. В одном запросе можно отправить не более 100 бонусов. По умолчанию значение `false`.
assignment_id	string Идентификатор ответа исполнителя на задание, за которое выплачивается бонус.
skip_invalid_items	boolean Параметры валидации JSON-объектов: `true` — выдать бонус, если JSON-объект со сведениями о бонусе прошел валидацию. В противном случае пропустить выдачу бонуса. `false` — остановить операцию и не выдавать бонусы, если хотя бы один JSON-объект не прошел валидацию. По умолчанию значение `false`.
operation_id	string Идентификатор операции. Можно использовать при любом способе обработки запроса.

Тело запроса

{
  "user_id": "21c4f092ebad180cf56b9babe0ef9f19",
  "amount": 1.5,
  "assignment_id": "6946cefa-32af-4f62-b530-8d2c71fa2966",
  "private_comment": "Good job!",
  "public_title": {
    "EN": "Completed tasks"
  },
  "public_message": {
    "EN": "10 tasks successfully completed"
  },
  "without_message": false
}

Параметр	Описание
user_id	string Обязательный параметр. Идентификатор исполнителя.
amount	float Обязательный параметр. Сумма бонуса в долларах.
assignment_id	string Идентификатор ответа исполнителя на задание, за которое выплачивается бонус.
private_comment	string Комментарий, доступный только заказчику.
public_title	object Заголовок сообщения для исполнителя. Может быть на нескольких языках (сообщение придет на языке исполнителя). Формат: "`<язык RU/EN/TR/ID/FR>": "<текст заголовка>`".
public_message	object Текст сообщения для исполнителя. Может быть текст на нескольких языках (сообщение придет на языке исполнителя). Формат: `"<язык RU/EN/TR/ID/FR>": "<текст сообщения>"`.
without_message	boolean Позволяет не отправлять исполнителю сообщение о бонусе. По умолчанию `false`. Для того чтобы выдать бонус без сообщения, нужно указать `null` для `public_title` и `public_message` и `true` для `without_message`.

Ответ

Формат ответа зависит от значения query-параметра async_mode.

Сведения о бонусах (async_mode=false)

Сведения об операции (async_mode=true)

{
  "items": {
    "0": {details of a reward #0},
    "2": {details of a reward #2},
    "<N>": {details of a reward #N}
  },
  "validation_errors": {
    "1": {validation errors for a reward #1},
    "3": {validation errors for a reward #3},
    "<N>": {validation errors for a reward #N}
  }
}

Параметр

Описание

items

string

Объект со сведениями о выданных бонусах.

validation_errors