PRprolific
messages

Start a conversation

Changed on

Starts a new conversation with a participant or researcher, separate from the default one between you. Give it a subject and a topic, and optionally the study it is about and a first message.

Send further messages into it with POST /api/v1/messages and its conversation_id. Other conversations with the same person are untouched.

For participant senders, study_id must be a study the participant has a submission for, and the recipient must be that study's researcher, publisher or workspace. Otherwise the request is rejected with a 400.

post/api/v1/conversations/

Request

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

Request body

recipient_idstring required

The participant or researcher to start the conversation with.

subjectstring required

What the conversation is about, shown as its title.

topic'payment-timing' | 'payment-issues' | 'technical-issues' | 'feedback' | 'rejections' | 'other' required

Which of the fixed categories the conversation falls under.

study_idstring

The study it relates to.

workspace_idstring

Start it as this workspace rather than as yourself. Requires workspace messaging.

bodystring

A first message, sent into the conversation as part of creating it.

Response

The new conversation

idstring required

The conversation id. The same value appears as channel_id on its messages.

subjectstring nullable required

What the conversation is about. Null on conversations that predate subjects.

topic'payment-timing' | 'payment-issues' | 'technical-issues' | 'feedback' | 'rejections' | 'other' required

One of the message categories, or null.

study_idstring nullable required

The study the conversation is about, or null.

unread_countinteger required

Unread messages for the caller.

last_message_bodystring nullable

Body of the most recent message.

datetime_createdstring date-time required
datetime_updatedstring date-time required

When the most recent message was sent.

repliedboolean

Only when listing a broadcast's conversations. Whether the recipient has replied. Your own follow-ups don't count.

Changes

  • 8ad56496a97cRevision changes
    • info

      added the optional property to the response with the status

  • d8ab5baad529Revision changes
    • warning

      added the new payment-timing enum value to the / response property for the response status

    • info

      added the optional property to the response with the status