Send a message | Prolific API

Send a message to a participant or another researcher

Authentication

Authorizationstring

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>.

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>`.

Request

This endpoint expects an object.

recipient_idstringRequired

Recipient user's id

bodystringRequired

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

study_idstringRequired

This study is the reason for this message

Response

The message has been sent

1	import requests
2
3	url = "https://api.prolific.com/api/v1/messages/"
4
5	payload = {
6	"recipient_id": "619e049f7648a4e1f8f3645b",
7	"body": "Thanks for participating in my study",
8	"study_id": "719e049f7648a4e1f8f3645a"
9	}
10	headers = {
11	"Authorization": "<apiKey>",
12	"Content-Type": "application/json"
13	}
14
15	response = requests.post(url, json=payload, headers=headers)
16
17	print(response.json())

Authentication

Request

Response

Errors