For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Go to app
DocumentationAPI Reference
DocumentationAPI Reference
  • API Reference
    • Introduction
    • Users
    • Taskflow
    • AI Task Builder
    • Studies
    • Representative sample studies
    • study-collections
    • Filter Sets
    • Participant Groups
    • Custom Groups
    • Study Distribution
    • Submissions
      • Submissions guide
      • Submission object
      • GETList submissions
      • GETRetrieve a submission
      • POSTApprove or reject a submission
      • POSTRequest the participant who submitted the response to return their response
      • POSTBulk approve submissions
    • Bonuses
    • Messages
    • Workspaces
    • Projects
    • Surveys
    • Webhooks
    • Invitations
    • Reward Recommendations
    • Testing
    • Well Known Endpoints
Go to app
LogoLogo
API ReferenceSubmissions

Request the participant who submitted the response to return their response

|View as Markdown|Open in Claude|
POST
https://api.prolific.com/api/v1/submissions/:id/request-return/
POST
/api/v1/submissions/:id/request-return/
$curl -X POST https://api.prolific.com/api/v1/submissions/id/request-return/ \
>     -H "Authorization: Token <token>" \
>     -H "Content-Type: application/json" \
>     -d '{
>  "request_return_reasons": [
>    "Withdrew consent.",
>    "Did not finish study."
>  ]
>}'
1{
2  "id": "a1b2c3d4-e5f6-7890-ab12-cd34ef567890",
3  "status": "RETURNED",
4  "participant": "participant_12345",
5  "return_requested": "2024-01-15T09:30:00Z"
6}
**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" />
Was this page helpful?
Previous

Approve or reject a submission

Next

Bulk approve submissions

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.

Example

Authentication

AuthorizationToken

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
the database id of the submission instance
statusenum
The current status of the submission
participantstring
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

4XX
Client Request Error