Sign in

v4

OpenAPI 3.1.02026-07-31121440441.0 KB
submissions

Approve or reject a submission

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.

post/api/v1/submissions/{id}/transition/

Path parameters

idstring required

Submission id. This is the ID we pass to the survey platform using %SESSION_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

action'APPROVE' | 'COMPLETE' | 'REJECT' | 'RETURN' | 'START' | 'SCREEN_OUT' | 'UNREJECT' | 'UNRETURN' required

The action that should be performed on the submission.

messagestring

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_category'TOO_QUICKLY' | 'TOO_SLOWLY' | 'FAILED_INSTRUCTIONS' | 'INCOMP_LONGITUDINAL' | 'FAILED_CHECK' | 'LOW_EFFORT' | 'MALINGERING' | 'NO_CODE' | 'BAD_CODE' | 'NO_DATA' | 'UNSUPP_DEVICE' | 'OTHER'

Required if action is 'REJECT', it sums as the category of the rejection.

completion_codestring

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.

Response

OK

idstring required

The id of the submission

completed_atstring nullable

The time the submission was completed at.

entered_codestring nullable

The completion code used by the participant to complete the study.

participantstring

Participant id.

started_atstring required

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

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

The current status of the submission

study_idstring required

Study id.