v4

latestOpenAPI 3.1.02026-07-31121440441.0 KB

messages

Send a message

Send a message to a participant or another researcher

post/api/v1/messages/

Authorizationstring required

The Prolific API uses API token to authenticate requests. You can create an API token directly from your settings.

Your API token does not have an expiry date and carries full permission, so be sure to keep them secure.

If your token is leaked, delete it and create a new one directly in the app.

In your requests add Authorization header with the value Token <your token>.

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

The message has been sent

object required