Request the participant who submitted the response to return their response

This is an experimental feature that may be subject to change in the future.
It offers researchers the ability to ask a participant to return a submission. The return reason must be provided in the request and can be any free text string.
The Prolific UI allows users to select any of the following options:

Didn’t finish the study
Encountered technical problems
Withdrew consent
Other ( uses the free text input)

This constructs a message around the reasons provided so there is no need to provide additional text beyond the reasons.

**This is an experimental feature that may be subject to change in the future.** <br/> It offers researchers the ability to ask a participant to return a submission. The return reason must be provided in the request and can be any free text string. <br/> The Prolific UI allows users to select any of the following options: * Didn't finish the study * Encountered technical problems * Withdrew consent * Other ( uses the free text input) This constructs a message around the reasons provided so there is no need to provide additional text beyond the reasons. <img alt="Example" src="/assets/img/api/message.png" />

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

Path Parameters

idstringRequired

The submission id

Request

This endpoint expects an object.

request_return_reasonslist of stringsRequired

Response

A message is sent to the participant belonging to the submission asking them to return.

idstring or null

the database id of the submission instance

statusenum or null

The current status of the submission

participantstring or null

The participant who took part in the study.

return_requesteddatetime or null

The date and time when a return request for the submission was made.

1	import requests
2
3	url = "https://api.prolific.com/api/v1/submissions/id/request-return/"
4
5	payload = { "request_return_reasons": ["Withdrew consent.", "Did not finish study."] }
6	headers = {
7	"Authorization": "<apiKey>",
8	"Content-Type": "application/json"
9	}
10
11	response = requests.post(url, json=payload, headers=headers)
12
13	print(response.json())

1	{
2	"id": "string",
3	"status": "ACTIVE",
4	"participant": "string",
5	"return_requested": "2024-01-15T09:30:00Z"
6	}

Authentication

Path Parameters

Request

Response

Errors