Messages for users

You can send messages to users. You can specify recipients in a list or select artists using a filter.

The sent message is added to a new message thread. Until the first response is received, the message thread is located in the folder UNREAD. If the thread contains several addresses and one of them responds, a new message thread will be created.

Example of a message thread

Contains messages and parameters:

{
  "id": "558110f401d292324c0da8bd",
  "topic": {
    "EN": "You received a bonus!"
  },
  "interlocutors_inlined": true,
  "interlocutors": [
    {
      "id": "111bd25f1bb71f37844e2a9355faad67",
      "role": "REQUESTER",
      "myself": true
    },
    {
      "id": "2225cfb24c15b7d691818f5ac9d07f70",
      "role": "USER"
    }
  ],
  "messages_inlined": true,
  "messages": [
    {
      "text": {
        "EN": "Thank you!"
      },
      "from": {
        "id": "2225cfb24c15b7d691818f5ac9d07f70",
        "role": "USER"
        },
        "created": "2017-01-31T11:02:31"
    {
      "text": {
        "EN": "You were awarded a bonus for a good job!"
      },
      "from": {
        "id": "111bd25f1bb71f37844e2a9355faad67",
        "role": "REQUESTER",
        "myself": true
      },
      "created": "2017-01-31T09:38:01"
    }
  ],
  "compose_details": {
    "recipients_select_type": "DIRECT",
    "recipients_ids": [
      "2225cfb24c15b7d691818f5ac9d07f70"
    ]
  },
  "answerable": true,
  "folders": [
    "INBOX",
    "OUTBOX"
  ],
  "created": "2017-01-31T09:38:01"
}
Key descriptions

Key

Value

Data type

id

Message thread ID.

String

topic

Message thread title.

JSON

interlocutors_inlined

Access to information about the sender and recipients.

  • true — Information is available in the interlocutors field.

  • false — Information is available in a separate request.

Boolean

interlocutors

Information about the sender and recipients, sorted by ID.

JSON

interlocutors.id

ID of the sender or recipient.

String

interlocutors.role

Role of the sender or recipient in Toloka:

  • USER — Performer.

  • REQUESTER

  • ADMINISTRATOR

  • SYSTEM — For messages sent automatically.

String

interlocutors.myself

Marks a sender or recipient with your ID. If this is your ID, it is set to true.

Boolean

messages_inlined

Access to message threads:

  • true — The message is available in the messages field.

  • false — The message is available in a separate request.

Boolean

messages

Messages in the thread. Messages are sorted by date of creation (newest first).

JSON

messages.text

Message text.

JSON

messages.from

Information about the sender.

String

messages.from.id

The sender's ID.

String

messages.from.role

The sender's role in Toloka:

  • USER — Performer.

  • REQUESTER

  • ADMINISTRATOR

  • SYSTEM — For messages sent automatically.

String

messages.from.myself

Marks a sender with your ID. If you are the sender, it is set to true.

Boolean

messages.created

Date the message was created.

String

compose_details

For messages that you sent: details of the POST request for creating the message.

JSON

answerable

Whether the message can be responded to:

  • true — The performer can respond to the message.

  • false — The performer cannot respond to the message.

Boolean

folders
Folders where the thread is located.
  • INBOX — Inbox.
  • OUTBOX — Sent.
  • AUTOMATIC_NOTIFICATION — Notifications.
  • IMPORTANT — Important.
  • UNREAD — Unread.
Array

created

Date the first message in the thread was created.

String