API ReferenceSubmissions

Request the participant who submitted the response to return their response

View as MarkdownOpen in Claude
**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

AuthorizationToken

Header authentication of the form Token <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.

Errors