PRprolific
messages

Send a message

Changed on

Send a message to a participant or another researcher.

By default the message goes into the current conversation between you and the recipient, which is created if it doesn't exist yet. Pass conversation_id to send into a specific conversation instead. The recipient must be a member of it, otherwise the request is rejected with a 400, and a conversation you are not a member of is reported as not found.

A message that names a study_id or a category also sets the study and topic on the conversation it lands in. For participant senders, the study is set on the conversation only if the participant has a submission for that study and the recipient is the study's researcher, publisher or workspace. Otherwise the message is still sent, and the conversation's study is left unchanged.

post/api/v1/messages/

Request

  • Base URL
    https://api.prolific.com
  • URL
    https://api.prolific.com/api/v1/messages/
  • Auth
    API key in header Authorization

Request body

recipient_idstring required

Recipient user's id

bodystring required

Message Body. Text is sanitised for safe storage and display.

study_idstring required

This study is the reason for this message

category'payment-timing' | 'payment-issues' | 'technical-issues' | 'feedback' | 'rejections' | 'other'

What the message is about. Also becomes the conversation's topic.

conversation_idstring

Send into this conversation rather than the default one between you and the recipient. Get ids from GET /api/v1/conversations. The recipient must be a member.

Response

The message has been sent

object required

Changes

  • 6c9aa73fa51fRevision changes
    • warning

      deleted the header request parameter Authorization

    • info

      the endpoint scheme security token was added to the API

  • 99b5dc540b1cRevision changes
    • info

      added the new optional request property

    • info

      added the new optional request property