Rewards for users

You can issue rewards to one or more users (in addition to payment for completed tasks). The bonus amount can be from $0.01 to $100 per user per time.

The example below shows a JSON object with information about a reward and key descriptions.

You can use the API for the following operations:

Sample reward in JSON

{
  "user_id": "21c4f092ebad180cf56b9babe0ef9f19",
  "amount": 1.5,
  "assignment_id": "ACCEPTED",
  "private_comment": "pool_23214",
  "public_title": {
    "EN": "Good job!",
    "RU": "Молодец!"
  },
  "public_message": {
    "EN": "Ten tasks completed",
    "RU": "Выполнено 10 заданий"
  },
  "without_message": false,
  "created": "2016-07-08T12:51:00",
  "id": 65
}

Key descriptions

Key

Value

Data type

Required during creation

user_id

User ID.

String

Yes

amount

The dollar amount of the reward.

Number

Yes

assignment_id

ID of the performer's response to the task a reward is issued for.

String

No

private_comment

Comments that are only visible to the requester.

String

No

public_title

The subject of the message for the user. You can enter the subject in multiple languages (the message is sent in the user's language). Format: ""<language RU/EN/TR/ID/FR>": "<title text>".

JSON

No

public_message

Message text for the user. You can enter the text in multiple languages (the message is sent in the user's language). Format: "<language RU/EN/TR/ID/FR>": "<message text>".

String

No

without_message

Allows you not to send a reward message to the performer. The default value is false.

To issue a reward without a message, specify null for public_title and public_message and true for without_message.

Boolean

No

created

Date the reward was awarded, in UTC using ISO 8601 format: YYYY-MM-DDThh:mm:ss[.sss].

String

Not used.

id

Reward ID.

String

Not used.

Key

Value

Data type

Required during creation

user_id

User ID.

String

Yes

amount

The dollar amount of the reward.

Number

Yes

assignment_id

ID of the performer's response to the task a reward is issued for.

String

No

private_comment

Comments that are only visible to the requester.

String

No

public_title

The subject of the message for the user. You can enter the subject in multiple languages (the message is sent in the user's language). Format: ""<language RU/EN/TR/ID/FR>": "<title text>".

JSON

No

public_message

Message text for the user. You can enter the text in multiple languages (the message is sent in the user's language). Format: "<language RU/EN/TR/ID/FR>": "<message text>".

String

No

without_message

Allows you not to send a reward message to the performer. The default value is false.

To issue a reward without a message, specify null for public_title and public_message and true for without_message.

Boolean

No

created

Date the reward was awarded, in UTC using ISO 8601 format: YYYY-MM-DDThh:mm:ss[.sss].

String

Not used.

id

Reward ID.

String

Not used.