Consent Submissions

Export consent submissions for a study

Initiates an export of consent submissions as a ZIP file containing PDFs for a specific study.

The export runs asynchronously. Use the returned export ID to check the status and download the file when complete.

post/studies/{studyId}/consent-submissions/export

Request

  • Base URL: https://api.rallyuxr.com/api/public/v1
  • URL: https://api.rallyuxr.com/api/public/v1/studies/{studyId}/consent-submissions/export
  • Auth: HTTP bearer

Path parameters

studyIdstring required

The study ID

Response

Export job created successfully

exportIdstring required

The export ID to use for checking status

status'NOT_STARTED' | 'EXPORTING' | 'COMPLETED' | 'PARTIAL' | 'ERROR' required

The current status of the export. PARTIAL means the export finished but some consent submission PDFs could not be included in the ZIP file; see failedCount and failedConsentSubmissionIds.

createdAtstring required

When the export was created

Changes

No recorded changes to this operation across all 1 revision of this API.