Sign in

v4

OpenAPI 3.1.02026-07-31121440441.0 KB
submissions

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

post/api/v1/submissions/{id}/request-return/

Path parameters

idstring required

The submission id

Headers

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

Request body

request_return_reasonsstring[] required

Response

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

idstring

the database id of the submission instance

status'ACTIVE' | 'APPROVED' | 'AWAITING REVIEW' | 'SCREENED OUT' | 'REJECTED' | 'RESERVED' | 'RETURNED' | 'TIMED-OUT' | 'UNKNOWN'

The current status of the submission

participantstring

The participant who took part in the study.

return_requestedstring date-time nullable

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