Skip to navigation
API ReferenceSubmissions

Approve or reject a submission

View as MarkdownOpen in Claude

Transition a submission to APPROVED, REJECTED, PARTIALLY APPROVED, AWAITING REVIEW or SCREENED OUT. Once the status is changed, it can not be restored to its previous value.

You can only transition a submission to PARTIALLY APPROVED or SCREENED OUT by:

  • setting up the study with the appropriate completion codes (only some workspaces have access to these features)
  • providing the correct completion code in the request body
  • providing the necessary data in the request body (to PARTIALLY APPROVE a submission)

Note this endpoint is idempotent, so if you make the same request twice, the second request will be ignored.

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

Submission id. This is the ID we pass to the survey platform using %SESSION_ID%

Request

This endpoint expects an object.
actionenumRequired
The action that should be performed on the submission.
messagestringOptional
Required if action is 'REJECT'. Message sent to the participant explaining the reason for the rejection. It must be at least 100 chars long.
rejection_categoryenumOptional
Required if action is 'REJECT', it sums as the category of the rejection.
completion_codestringOptional

Required if the action is ‘COMPLETE’. The completion code must match a value provided when creating the study, and the actor must have been set to researcher. Any actions that were provided during the set up of the completion code (e.g. automatically approve) will then be carried out.

completion_code_dataobjectOptional

Required if the action is ‘COMPLETE’ and the code has the action “DYNAMIC_PAYMENT” associated with it.

Response

OK
idstringRead-only
The id of the submission
started_atstring

The date and time that the user started the submission (UTC)

statusenum
The current status of the submission
study_idstring
Study id.
completed_atstring or nullOptional
The time the submission was completed at.
entered_codestring or nullOptional
The completion code used by the participant to complete the study.
participantstringOptional
Participant id.
payment_infoobject or nullOptionalRead-only

The submission’s payment state. null if it has not yet entered payment.

Errors

4XX
Client Request Error