- Getting Started
- Authentication
- Error Handling
- Versioning
- Security
- API Reference
- Access Policies
- Assignments
- Create AssignmentGroupCourseVersion
- List AssignmentGroupCourseVersions
- Create AssignmentGroupDataExport
- Get AssignmentGroupHeadlineInsight
- Create AssignmentGroup
- Get AssignmentGroup
- Update AssignmentGroup
- Delete AssignmentGroup
- Get AssignmentHeadlineInsight
- Get AssignmentItemAudio
- Update AssignmentItemAudio
- Get AssignmentItemDocument
- Update AssignmentItemDocument
- Get AssignmentItemEmbed
- Update AssignmentItemEmbed
- Get AssignmentItemNote
- Update AssignmentItemNote
- Create AssignmentItemPulse
- Get AssignmentItemQuiz
- Update AssignmentItemQuiz
- Get AssignmentItemReview
- Update AssignmentItemReview
- Delete AssignmentItemReview
- Create AssignmentItemReview
- Get AssignmentItemScorm
- Update AssignmentItemScorm
- Create AssignmentItemSelfAssessmentOutcome
- Get AssignmentItemSurvey
- Update AssignmentItemSurvey
- Get AssignmentItemTextEntry
- Update AssignmentItemTextEntry
- Get AssignmentItemUpload
- Update AssignmentItemUpload
- Get AssignmentItemVideo
- Update AssignmentItemVideo
- Get AssignmentItemZip
- Update AssignmentItemZip
- Create AssignmentManualReview
- Create AssignmentReattempt
- Create AssignmentReset
- Create AssignmentRevocation
- Delete AssignmentRevocation
- Get AssignmentScormResult
- Create AssignmentScormResult
- Create AssignmentSelfAssessmentReport
- Create Assignment
- List Assignments
- Get Assignment
- Update Assignment
- Attempts
- List AttemptCharts
- List AttemptInsights
- Create AttemptLock
- Update AttemptLock
- Delete AttemptLock
- Create AttemptOverride
- List AttemptOverrides
- Get AttemptPlayerState
- List AttemptResultConfigs
- List AttemptSchedules
- Get AttemptSchedule
- Update AttemptSchedule
- Create AttemptSitting
- Create AttemptSubmission
- List AttemptTagLabels
- Create AttemptTimerReset
- List AttemptTimers
- Get AttemptTimer
- Update AttemptTimer
- Create Attempt
- List Attempts
- Get Attempt
- Update Attempt
- Assign Moderating Markers
- Unassign Moderating Markers
- Assign Backreaders
- Unassign Backreaders
- Assign Escalating Markers
- Unassign Escalating Markers
- Assign Auditing Markers
- Unassign Auditing Markers
- Assign Provisional Markers
- Unassign Provisional Markers
- List EnrichedAttemptOptions
- List EnrichedAttempts
- Create ExamPreview
- Create ExportEnrichedAttempt
- Get PlayerAttempt
- Update PlayerAttempt
- Delete PlayerAttempt
- Get PlayerAudioResponse
- Update PlayerAudioResponse
- Get PlayerClozeDragAndDropResponse
- Update PlayerClozeDragAndDropResponse
- Get PlayerClozeDropDownResponse
- Update PlayerClozeDropDownResponse
- Get PlayerClozeTextResponse
- Update PlayerClozeTextResponse
- Get PlayerEmqGroup
- Get PlayerFileUploadResponse
- Update PlayerFileUploadResponse
- Get PlayerFreeTextResponse
- Update PlayerFreeTextResponse
- Get PlayerImageHotspotResponse
- Update PlayerImageHotspotResponse
- Get PlayerInformationalResponse
- Update PlayerInformationalResponse
- Get PlayerMultipleChoiceResponse
- Update PlayerMultipleChoiceResponse
- Get PlayerRankedResponse
- Update PlayerRankedResponse
- Get PlayerSection
- Update PlayerSection
- Get PlayerShortAnswerResponse
- Update PlayerShortAnswerResponse
- Get PlayerSingleChoiceResponse
- Update PlayerSingleChoiceResponse
- Get PlayerSpreadsheetResponse
- Update PlayerSpreadsheetResponse
- Get PlayerVideoResponse
- Update PlayerAudioResponse
- Update PlayerEmqGroup
- Auditing
- Authentication
- Create ADFS AuthenticationOption
- Get ADFS AuthenticationOption
- Update ADFS AuthenticationOption
- Delete ADFS AuthenticationOption
- Create Auth0 AuthenticationOption
- Get Auth0 AuthenticationOption
- Update Auth0 AuthenticationOption
- Delete Auth0 AuthenticationOption
- Create JWT AuthenticationOption
- Get JWT AuthenticationOption
- Update JWT AuthenticationOption
- Delete JWT AuthenticationOption
- Get Local AuthenticationOption
- Update Local AuthenticationOption
- Create LTI1.1 AuthenticationOption
- Get LTI1.1 AuthenticationOption
- Update LTI1.1 AuthenticationOption
- Delete LTI1.1 AuthenticationOption
- Create LTI1.3 AuthenticationOption
- Get LTI1.3 AuthenticationOption
- Update LTI1.3 AuthenticationOption
- Delete LTI1.3 AuthenticationOption
- Create SAML AuthenticationOption
- Get SAML AuthenticationOption
- Update SAML AuthenticationOption
- Delete SAML AuthenticationOption
- List AuthenticationOptions
- Create BotSession
- Activate MFA
- Get MfaConfig
- Create MFAConfig
- Create MfaDeactivation
- Create PersonalAccessToken
- List PersonalAccessTokens
- Update PersonalAccessToken
- Delete PersonalAccessToken
- List PublicAuthenticationOptions
- Get Token
- Delete own UserSession
- Create ZapierApiKey
- List ZapierApiKeys
- Update ZapierApiKey
- Delete ZapierApiKey
- Billing
- Certificates
- Collections
- Create Annotation
- List Annotations
- Get Annotation
- Update Annotation
- Delete Annotation
- Create CollectionAccess
- Delete CollectionAccess
- Create CollectionFolder
- List CollectionFolders
- Get CollectionFolder
- Update CollectionFolder
- Delete CollectionFolder
- Reorder CollectionFolder Items
- Create CollectionSubFolder
- Get CollectionSubFolder
- Update CollectionSubFolder
- Delete CollectionSubFolder
- Reorder CollectionSubFolder Items
- Create CollectionItemAudio
- List CollectionItemAudio (Use Generic)
- Get CollectionItemAudio
- Update CollectionItemAudio
- Delete CollectionItemAudio
- Get CollectionItemDocument
- Update CollectionItemDocument
- Delete CollectionItemDocument
- Create CollectionItemDocument
- Create CollectionItemEmbed
- List CollectionItemEmbeds (Use Generic)
- Get CollectionItemEmbed
- Update CollectionItemEmbed
- Delete CollectionItemEmbed
- Create CollectionItemNote
- List CollectionItemNotes (Use Generic)
- Get CollectionItemNote
- Update CollectionItemNote
- Delete CollectionItemNote
- Create CollectionItemQuiz
- List CollectionItems - use generic CollectionItem
- Get CollectionItemQuiz
- Update CollectionItemQuiz
- Delete CollectionItemQuiz
- Create CollectionItemVideo
- List CollectionItems - use generic CollectionItem
- Get CollectionItemVideo
- Update CollectionItemVideo
- Delete CollectionItemVideo
- Create CollectionItemZip
- List CollectionItems - use generic CollectionItem
- Get CollectionItemZip
- Update CollectionItemZip
- Delete CollectionItemZip
- List CollectionItems
- List CollectionMocks
- Create CollectionProgress
- List CollectionProgresses
- Update CollectionProgress
- Get CollectionProgress
- List CollectionSubFolders
- Get CollectionTagBreakdown
- List Collections
- Create Collection
- Get Collection
- Update Collection
- Delete Collection
- Reorder Collection Folders
- Reorder Collection Items
- Create Highlight
- List Highlights
- Get Highlight
- Update Highlight
- Delete Highlight
- Create or Update PDF Annotation
- List PDF Annotations
- Get PDF Annotation
- Delete PDF Annotation
- Content Metadata
- Courses
- Create CourseFolder
- List CourseFolders
- Get CourseFolder
- Update CourseFolder
- Delete CourseFolder
- Update CourseFolder Items
- Create CourseItemAudio
- List CourseItemAudio (Use Generic)
- Get CourseItemAudio
- Update CourseItemAudio
- Delete CourseItemAudio
- Create CourseItemDocument
- List CourseItemDocument (Use Generic)
- Get CourseItemDocument
- Update CourseItemDocument
- Delete CourseItemDocument
- Create CourseItemEmbed
- List CourseItemEmbed (Use Generic)
- Get CourseItemEmbed
- Update CourseItemEmbed
- Delete CourseItemEmbed
- Create CourseItemNote
- List CourseItemNote (Use Generic)
- Get CourseItemNote
- Update CourseItemNote
- Delete CourseItemNote
- Create CourseItemQuiz
- List CourseItemQuiz (Use Generic)
- Get CourseItemQuiz
- Update CourseItemQuiz
- Delete CourseItemQuiz
- Create CourseItemScorm
- List CourseItemScorm (Use Generic)
- Get CourseItemScorm
- Update CourseItemScorm
- Delete CourseItemScorm
- Create CourseItemSurvey
- List CourseItemSurvey (Use Generic)
- Get CourseItemSurvey
- Update CourseItemSurvey
- Delete CourseItemSurvey
- Create CourseItemTextEntry
- List CourseItemTextEntry (Use Generic)
- Get CourseItemTextEntry
- Update CourseItemTextEntry
- Delete CourseItemTextEntry
- Create CourseItemUpload
- List CourseItemUpload (Use Generic)
- Get CourseItemUpload
- Update CourseItemUpload
- Delete CourseItemUpload
- Create CourseItemVideo
- List CourseItemVideo (Use Generic)
- Get CourseItemVideo
- Update CourseItemVideo
- Delete CourseItemVideo
- Create CourseItemZip
- List CourseItemZip (Use Generic)
- Get CourseItemZip
- Update CourseItemZip
- Delete CourseItemZip
- List CourseItems
- Create Course
- Get Course
- Update Course
- Delete Course
- Reorder Course Folders
- Reorder Course Items
- Exams
- Create AttemptRevokeReversalPOST
- List AttemptRevokeReversalsGET
- Get AttemptRevokeReversalGET
- Update AttemptRevokeReversalPATCH
- Delete AttemptRevokeReversalDELETE
- Get ExamAttemptHeadlineInsightGET
- Create ExamCandidateExportPOST
- Get ExamHallGET
- List ExamQuestionStatsGET
- Create ExamQuestionStatsExportPOST
- Create ExamV2POST
- Find ExamV2sGET
- Get ExamV2GET
- Update ExamV2PATCH
- Delete ExamV2DELETE
- Create Internal Markers GroupPOST
- Set Shared Markers GroupPATCH
- Create Internal Moderating Markers GroupPOST
- Set Shared Moderating Markers GroupPATCH
- Set Shared Escalating Markers GroupPATCH
- Set Shared Auditing Markers GroupPATCH
- Create Internal Escalating Markers GroupPOST
- Create Internal Auditing Markers GroupPOST
- Create Internal BackReading Markers GroupPOST
- Set Shared BackReading Markers GroupPATCH
- Update Exam SectionPATCH
- Creates a new draft version of the underlying quizPOST
- Discards the current draft quiz and replaces it with the latest published version.PATCH
- Sets a quiz as the current published version. New attempts for this exam will use the publishedVersion quiz.PATCH
- Create ExamVoucherBatchJobPOST
- Create ExamVoucherExportPOST
- Create ExamVoucherPOST
- List ExamVouchersGET
- Get ExamVoucherGET
- Update ExamVoucherPATCH
- Delete ExamVoucherDELETE
- Create ExamineeNotificationPOST
- Verify ExamVoucherPOST
- Create AttemptRevokeReversal
- Insights
- Integrations
- Library
- Create ContentEmbedDatum
- Create Content
- Get Content
- Update Content
- Delete Content
- Create File
- Get File
- Get Note
- Delete Note
- Update Note
- Create Note
- Create ScormCourse
- Get ScormCourse
- Update ScormCourse
- Delete ScormCourse
- Create SurveyItem
- Get SurveyItem
- Update SurveyItem
- Delete SurveyItem
- Create SurveyPage
- Get SurveyPage
- Update SurveyPage
- Delete SurveyPage
- Update Survey Page Items
- Create SurveyResponse
- Create Survey
- Get Survey
- Update Survey
- Delete Survey
- Update Survey Pages
- Marking
- Mobile
- Create MobileAttempt
- List MobileAttempts
- Get MobileAttempt
- Update MobileAttempt
- Create MobileCollectionItem
- List MobileCollectionItems
- Get MobileCollectionItem
- Update MobileCollectionItem
- Delete MobileCollectionItem
- List Collections
- Get Collection
- List MobileResponses
- Get MobileResponse
- Update MobileResponse
- Get Session
- Get MobileSpacedLearning
- Update MobileSpacedLearning
- Add MobileStudyItems
- Remove MobileStudyItems
- Create MobileUser
- Get MobileUser
- Notifications
- Portals
- Proctoring
- Quizzes
- Create EmqGroupExport
- Create EmqGroupImportValidation
- Create EmqGroupImport
- Create GenerateTestJob
- Get GenerateTestJob
- Create GeneratedTest
- Create QuestionExport
- Create QuestionImportValidation
- Create QuestionImport
- Create QuizEmqGroup
- Get QuizEmqGroup
- Update QuizEmqGroup
- Delete QuizEmqGroup
- Update quiz section questions.
- Get QuizPdfExport
- Create QuizQuestionAudioRecording
- List QuizQuestionAudioRecording
- Get QuizQuestionAudioRecording
- Update QuizQuestionAudioRecording
- Delete QuizQuestionAudioRecording
- Create QuizQuestionClozeDragAndDrop
- List QuizQuestionClozeDragAndDrop
- Get QuizQuestionClozeDragAndDrop
- Update QuizQuestionClozeDragAndDrop
- Delete QuizQuestionClozeDragAndDrop
- Create QuizQuestionClozeDropDown
- List QuizQuestionClozeDropDown
- Get QuizQuestionClozeDropDown
- Update QuizQuestionClozeDropDown
- Delete QuizQuestionClozeDropDown
- Create QuizQuestionClozeText
- List QuizQuestionClozeText
- Get QuizQuestionClozeText
- Update QuizQuestionClozeText
- Delete QuizQuestionClozeText
- Create QuizQuestionFileUpload
- List QuizQuestionFileUpload
- Get QuizQuestionFileUpload
- Update QuizQuestionFileUpload
- Delete QuizQuestionFileUpload
- Create QuizQuestionFreeText
- List QuizQuestionFreeText
- Get QuizQuestionFreeText
- Update QuizQuestionFreeText
- Delete QuizQuestionFreeText
- Create QuizQuestionImageHotspot
- List QuizQuestionImageHotspot
- Get QuizQuestionImageHotspot
- Update QuizQuestionImageHotspot
- Delete QuizQuestionImageHotspot
- Create QuizQuestionInformational
- List QuizQuestionInformational
- Get QuizQuestionInformational
- Update QuizQuestionInformational
- Delete QuizQuestionInformational
- Create QuizQuestionMultipleCorrect
- List QuizQuestionMultipleCorrect
- Get QuizQuestionMultipleCorrect
- Update QuizQuestionMultipleCorrect
- Delete QuizQuestionMultipleCorrect
- Create QuizQuestionRanked
- List QuizQuestionRanked
- Get QuizQuestionRanked
- Update QuizQuestionRanked
- Delete QuizQuestionRanked
- Create QuizQuestionShortAnswer
- List QuizQuestionShortAnswer
- Get QuizQuestionShortAnswer
- Update QuizQuestionShortAnswer
- Delete QuizQuestionShortAnswer
- Create QuizQuestionSingleCorrect
- List QuizQuestionSingleCorrect
- Get QuizQuestionSingleCorrect
- Update QuizQuestionSingleCorrect
- Delete QuizQuestionSingleCorrect
- Create QuizQuestionSpreadsheet
- List QuizQuestionSpreadsheet
- Get QuizQuestionSpreadsheet
- Update QuizQuestionSpreadsheet
- Delete QuizQuestionSpreadsheet
- Create QuizQuestionVideoRecording
- List QuizQuestionVideoRecording
- Get QuizQuestionVideoRecording
- Update QuizQuestionVideoRecording
- Delete QuizQuestionVideoRecording
- Create QuizSection
- List QuizSections
- Get QuizSection
- Update QuizSection
- Delete QuizSection
- Update quiz section questions.
- Add quiz section questions.
- Get QuizTagBreakdown
- Create Quiz
- Get Quiz
- Update Quiz
- Delete Quiz
- Update Quiz Questions
- Update Quiz Sections
- Update Quiz Content Sources
- Update Quiz Settings Source
- Get Test
- Delete Test
- List Tests
- Revision
- Search
- Shop
- Create CheckoutSession
- Get CheckoutSession
- Update CheckoutSession
- List LegacyAccessUpgradeOptions
- Create PortalStore
- List PortalStores
- Get PortalStore
- Update PortalStore
- Delete PortalStore
- Create ProductList
- List ProductLists
- Get ProductList
- Update ProductList
- Delete ProductList
- Add Products
- Remove Products
- Create Product
- List Products
- Get Product
- Update Product
- Delete Product
- Get StoreOffer
- User Groups
- Create UserGroupExport
- Create UserGroupLinkAccess
- List UserGroupLinkSettings
- Create UserGroupLinkSetting
- Get UserGroupLinkSetting
- Update UserGroupLinkSetting
- Validate UserGroupLink
- Get UserGroupLink
- Create UserGroup
- List UserGroups
- Get UserGroup
- Update UserGroup
- Delete UserGroup
- Add Users to UserGroup
- Remove Users from UserGroup
- Create UserImport
- List UserTypes
- Get UserType
- Update UserType
- User Feedback
- Users
- Create AccountClosureRequest
- Create AccountClosure
- Update AccountClosure
- Create BotUser
- List BotUsers
- List Documents
- Create EmailVerification
- Update EmailVerification
- Create ExternalExamSitting
- List ExternalExamSittings
- Update ExternalExamSitting
- Create GeneratedAccount
- Create InviteExport
- List Invites
- Get Invite
- Update Invite
- Create LearningRecordExport
- Create LearningRecord
- List LearningRecords
- Get LearningRecord
- Update LearningRecord
- Delete LearningRecord
- Get App Login QR Code
- Create MarketingConsent
- Delete MarketingConsent
- Create PasswordResetRequest
- Create PasswordReset
- Get PasswordReset
- Update PasswordReset
- Get Session Context
- Get UserAccount
- List UserEngagement
- Create UserPassword
- Create UserRegistration
- Get UserStat
- List Users
- Get User
- Update User
- Delete User
- Cookbook
- Schemas
- AccessMigration
- AccessPolicy
- AccessPolicyReset
- AccountClosure
- AccountClosureRequest
- ActionLog
- Annotation
- ApiError
- Assignment
- AssignmentFolder
- AssignmentGroup
- AssignmentGroupCourseVersion
- AssignmentGroupDataExport
- AssignmentGroupHeadlineInsight
- AssignmentHeadlineInsight
- AssignmentItemAudio
- AssignmentItemDocument
- AssignmentItemEmbed
- AssignmentItemNote
- AssignmentItemPulse
- AssignmentItemQuiz
- AssignmentItemScorm
- AssignmentItemReview
- AssignmentItemSurvey
- AssignmentItemTextEntry
- AssignmentItemSelfAssessmentOutcome
- AssignmentItemUpload
- AssignmentItemVideo
- AssignmentItemZip
- AssignmentManualReview
- AssignmentReattempt
- AssignmentReset
- AssignmentRevocation
- AssignmentScormResult
- Attempt
- AttemptChart
- AttemptInsight
- AssignmentSelfAssessmentReport
- AttemptLock
- AttemptMarksSubmission
- AttemptOverride
- AttemptPlayerState
- AttemptResultConfig
- AttemptRevokeReversal
- AttemptSchedule
- AttemptSitting
- AttemptSubmission
- AttemptTagLabel
- AttemptTimer
- AttemptTimerReset
- AttributeConfig
- AuthenticationOption
- AuthenticationOptionAdfs
- AuthenticationOptionAuth0
- AuthenticationOptionJwt
- AuthenticationOptionLocal
- AuthenticationOptionLti1p3
- AuthenticationOptionSaml
- AuthenticationOptionLti1p1
- AvailableAccessPolicy
- BackgroundJob
- BadRequestApiError
- BillingInfo
- BotSession
- BotUser
- Certificate
- ChartJs
- CheckoutSession
- CloneJob
- Collection
- CollectionAccess
- CollectionFolder
- CollectionItem
- CollectionItemAudio
- CollectionItemDocument
- CollectionItemEmbed
- CollectionItemNote
- CollectionItemQuiz
- CollectionItemVideo
- CollectionItemZip
- CollectionMock
- CollectionProgress
- CollectionSubFolder
- CollectionTagBreakdown
- Content
- ContentEmbedDatum
- Course
- CourseFolder
- CourseItem
- CourseItemAudio
- CourseItemDocument
- CourseItemEmbed
- CourseItemNote
- CourseItemQuiz
- CourseItemScorm
- CourseItemSurvey
- CourseItemTextEntry
- CourseItemUpload
- CourseItemVideo
- CourseItemZip
- CustomInsight
- Document
- EmailVerification
- EmqGroupExport
- EmqGroupImport
- EmqGroupImportValidation
- EnrichedAttempt
- EnrichedAttemptOption
- Exam-V-2
- ExamAttemptHeadlineInsight
- ExamCandidateExport
- ExamHall
- ExamineeNotification
- ExamPreview
- ExamQuestionStats
- ExamQuestionStatsExport
- ExamSchedule
- ExportEnrichedAttempt
- ExternalExamSitting
- ExternalProctorSession
- ExamVoucher
- ExternalProctorSessionResults
- ExamVoucherBatchJob
- FacetConfig
- ExamVoucherExport
- File
- Flag
- FlagExport
- ForbiddenApiError
- GeneratedAccount
- GeneratedTest
- GenerateTestJob
- GenericNotification
- GenericResource
- Highlight
- InsightsTagBreakdown
- Integration
- Invite
- InviteExport
- Invoice
- LearningRecord
- LearningRecordExport
- LegacyAccessUpgradeOption
- LoginQrCode
- ManageBillingSession
- MarketingConsent
- MarkingEntry
- MarkingSession
- MarkingState
- MAUPortalUsage
- MfaActivation
- MfaConfig
- MfaDeactivation
- MobileAttempt
- MobileAudioContent
- MobileCollection
- MobileCollectionFolder
- MobileCollectionItem
- MobileNote
- MobileQuiz
- MobileResponse
- MobileSession
- MobileSpacedLearning
- MobileStudyItem
- MobileUser
- Note
- NotFoundApiError
- NotificationGroup
- ObjectId
- PasswordReset
- PasswordResetRequest
- PAYGPortalUsage
- PersonalAccessToken
- PlayerAttempt
- PlayerAudioResponse
- PlayerClozeDragAndDropResponse
- PdfAnnotation
- PlayerClozeDropDownResponse
- PlayerClozeTextResponse
- PlayerEmqGroup
- PlayerFileUploadResponse
- PlayerFreeTextResponse
- PlayerInformationalResponse
- PlayerMultipleChoiceResponse
- PlayerRankedResponse
- PlayerSection
- PlayerImageHotspotResponse
- PlayerShortAnswerResponse
- PlayerSingleChoiceResponse
- Portal
- PlayerVideoResponse
- PortalStore
- PortalUsage
- ProctorCapture
- ProctorEventLog
- PlayerSpreadsheetResponse
- ProctorReview
- ProctorSession
- Product
- ProductList
- PublicAttributeConfig
- PublicAuthenticationOption
- PublicCertificate
- QuestionExport
- QuestionImport
- QuestionImportValidation
- QuestionSummary
- Quiz
- QuizEmqGroup
- QuizPdfExport
- QuizQuestionAudioRecording
- QuizQuestionClozeDragAndDrop
- QuizQuestionClozeDropDown
- QuizQuestionClozeText
- QuizQuestionFileUpload
- QuizQuestionFreeText
- QuizQuestionInformational
- QuizQuestionMultipleCorrect
- QuizQuestionRanked
- QuizQuestionShortAnswer
- QuizQuestionSingleCorrect
- QuizQuestionVideoRecording
- QuizSection
- QuizQuestionImageHotspot
- QuizSetupValidation
- QuizTagBreakdown
- RelationLink
- Relationship
- ResourceIdentifierArray
- ResourceIdentifierObject
- QuizQuestionSpreadsheet
- ResourceType
- Response
- ScormCourse
- SearchFilterConfig
- SearchResult
- SessionContext
- StoreOffer
- Study
- StudyItem
- SubPortal
- Subscription
- Survey
- SurveyItem
- SurveyPage
- SurveyResponse
- Tag
- TagSet
- Template
- Test
- TipSuggestion
- Token
- TransactionalEmail
- UnauthorizedApiError
- UrlLink
- UrlString
- User
- UserAccount
- UserAttribute
- UserEngagement
- UserGroup
- UserGroupExport
- UserGroupLink
- UserGroupLinkAccess
- UserGroupLinkSettings
- UserGroupLinkValidation
- UserImport
- UserPassword
- UserRegistration
- UserSession
- UserStats
- UserType
- WebhookSubscription
- ZapierApiKey
Create ExamVoucher
POST
/exam-vouchers
Request
Body Params application/vnd.api+jsonRequired
Example
{
"data": {
"type": "ExamVoucher",
"attributes": {
"code": "string",
"batch": "string",
"expiresAt": "string",
"isRevoked": true
},
"relationships": {
"owner": {
"data": {
"id": "FID001",
"type": "User"
}
},
"exam": {
"data": {
"id": "FID001",
"type": "Exam-V-2"
}
}
}
}
}Request Code Samples
Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api.synap.ac/v3/exam-vouchers' \
--header 'Content-Type: application/vnd.api+json' \
--data-raw '{
"data": {
"type": "ExamVoucher",
"attributes": {
"code": "string",
"batch": "string",
"expiresAt": "string",
"isRevoked": true
},
"relationships": {
"owner": {
"data": {
"id": "FID001",
"type": "User"
}
},
"exam": {
"data": {
"id": "FID001",
"type": "Exam-V-2"
}
}
}
}
}'Responses
🟢201
application/vnd.api+json
Body
Example
{
"data": {
"id": "FID001",
"type": "ExamVoucher",
"attributes": {
"createdAt": "string",
"code": "string",
"batch": "string",
"expiresAt": "string",
"isRedeemed": true,
"isRevoked": true,
"redeemedAt": "string",
"examName": "string"
},
"relationships": {
"owner": {
"data": {
"id": "FID001",
"type": "User"
}
},
"exam": {
"data": {
"id": "FID001",
"type": "Exam-V-2"
}
},
"subPortal": {
"data": {
"id": "FID001",
"type": "SubPortal"
}
},
"userGroup": {
"data": {
"id": "FID001",
"type": "UserGroup"
}
},
"redeemedBy": {
"data": {
"id": "FID001",
"type": "User"
}
},
"attempt": {
"data": {
"id": "FID001",
"type": "Attempt"
}
}
}
}
}🟢202
🟠400
🟠401
🟠403
🟠404
🟠409
Modified at 2026-02-03 10:07:40