Courses & quizzes

Courses & quizzes endpoints of the Zanfia Workspace API, with schemas and code samples.

9 min readLast updated Jul 26, 2026

Course content is addressed by the product id. Lesson and module statuses: draft, public, hidden, locked. Lesson content is Markdown and a PATCH replaces the whole body. All routes require a Authorization: Bearer header — see Authentication.

Course structure

GET/products/{productId}/course

Authorization

bearerAuth

AuthorizationBearer <token>

API key from Dashboard → Integrations → API, MCP and CLI.

In: header

Path Parameters

productId*string

Product id

Response Body

`application/json`

curl -X GET "https://example.com/products/string/course"

{  "courseId": "string",  "modulesCount": 0,  "modules": [    {      "id": "string",      "name": "string",      "description": "string",      "status": "draft",      "lessonsCount": 0,      "lessons": [        {          "id": "string",          "title": "string",          "description": "string",          "type": "video",          "status": "draft",          "videoStatus": "Pending",          "length": 0        }      ]    }  ]}

{  "error": "string"}

Lesson detail

GET/products/{productId}/course/lessons/{lessonId}

Authorization

bearerAuth

AuthorizationBearer <token>

API key from Dashboard → Integrations → API, MCP and CLI.

In: header

Path Parameters

productId*string

Product id

lessonId*string

Lesson id

Response Body

`application/json`

curl -X GET "https://example.com/products/string/course/lessons/string"

{  "courseId": "string",  "lesson": {    "id": "string",    "moduleId": "string",    "title": "string",    "description": "string",    "type": "video",    "status": "draft",    "content": "string",    "attachments": [      {        "uid": "string",        "name": "string",        "url": "string"      }    ],    "video": {      "type": "bunny",      "status": "Pending",      "url": "string",      "length": 0    },    "audio": {      "url": "string",      "mimeType": "string",      "length": 0,      "size": 0    },    "createdAt": "string",    "updatedAt": "string"  }}

{  "error": "string"}

Update a lesson

PATCH/products/{productId}/course/lessons/{lessonId}

Authorization

bearerAuth

AuthorizationBearer <token>

API key from Dashboard → Integrations → API, MCP and CLI.

In: header

Path Parameters

productId*string

Product id

lessonId*string

Lesson id

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

title?string

description?string

status?LessonStatus

Value in

"draft"
"public"
"hidden"
"locked"

content?string

Lesson body in Markdown — replaces the existing content.

videoMediaId?string

Bind this lesson's video to an uploaded media-library video (its mediaId). Copies the media's Bunny snapshot onto the lesson; requires the lesson to be a video lesson.

audioMediaId?string

Bind this lesson's audio to an uploaded media-library audio file (its mediaId). Copies the playable URL onto the lesson; requires the lesson to be an audio lesson.

unlockDelay?|

Days-after-join drip delay for this LESSON (hidden until N days after the buyer gained access). null clears. Mutually exclusive with unlock — when both are set unlockDelay wins at read time; pass null for the sibling to switch drip modes. Same semantics as the module-level fields.

unlock?|

Absolute-date drip for this lesson. afterDate / clientAccessDate are unix timestamps (or null); clientAccessDate scopes the lock to buyers who gained access on/after it. null clears the whole section.

Response Body

`application/json`

curl -X PATCH "https://example.com/products/string/course/lessons/string" \  -H "Content-Type: application/json" \  -d '{}'

{  "lessonId": "string"}

{  "error": "string"}

Delete a lesson (permanent)

DELETE/products/{productId}/course/lessons/{lessonId}

Authorization

bearerAuth

AuthorizationBearer <token>

API key from Dashboard → Integrations → API, MCP and CLI.

In: header

Path Parameters

productId*string

Product id

lessonId*string

Lesson id

Response Body

`application/json`

curl -X DELETE "https://example.com/products/string/course/lessons/string"

{  "deleted": true}

{  "error": "string"}

Add a module

POST/products/{productId}/course/modules

Authorization

bearerAuth

AuthorizationBearer <token>

API key from Dashboard → Integrations → API, MCP and CLI.

In: header

Path Parameters

productId*string

Product id

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name*string

description?string

Response Body

`application/json`

curl -X POST "https://example.com/products/string/course/modules" \  -H "Content-Type: application/json" \  -d '{    "name": "string"  }'

{  "moduleId": "string",  "name": "string"}

{  "error": "string"}

Update a module

PATCH/products/{productId}/course/modules/{moduleId}

Authorization

bearerAuth

AuthorizationBearer <token>

API key from Dashboard → Integrations → API, MCP and CLI.

In: header

Path Parameters

productId*string

Product id

moduleId*string

Module id

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name?string

description?string

status?ModuleStatus

Value in

"draft"
"public"
"hidden"
"locked"

unlockDelay?|

Days-after-join drip delay (module hidden until N days after the buyer gained access). null clears. Mutually exclusive with unlock — when both are set unlockDelay wins at read time; setting one does NOT auto-clear the other, so pass null for the sibling to switch drip modes.

unlock?|

Absolute-date drip. afterDate / clientAccessDate are epoch-ms (or null). null clears the whole section. Mutually exclusive with unlockDelay.

completionRequirement?|

Module progression gate. null clears (back to the all-lessons default); { type: 'quiz_pass' } requires every quiz lesson in the module to be passed.

Response Body

`application/json`

curl -X PATCH "https://example.com/products/string/course/modules/string" \  -H "Content-Type: application/json" \  -d '{}'

{  "moduleId": "string"}

{  "error": "string"}

Delete a module (permanent)

DELETE/products/{productId}/course/modules/{moduleId}

Authorization

bearerAuth

AuthorizationBearer <token>

API key from Dashboard → Integrations → API, MCP and CLI.

In: header

Path Parameters

productId*string

Product id

moduleId*string

Module id

Response Body

`application/json`

curl -X DELETE "https://example.com/products/string/course/modules/string"

{  "deleted": true}

{  "error": "string"}

Add a lesson

POST/products/{productId}/course/modules/{moduleId}/lessons

Authorization

bearerAuth

AuthorizationBearer <token>

API key from Dashboard → Integrations → API, MCP and CLI.

In: header

Path Parameters

productId*string

Product id

moduleId*string

Module id

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

title*string

description?string

type*LessonType

Value in

"video"
"externalVideo"
"audio"
"article"
"task"
"quiz"

videoMediaId?string

For a video lesson: bind it to an uploaded media-library video (its mediaId) at creation. Copies the media's Bunny snapshot onto the lesson.

audioMediaId?string

For an audio lesson: bind it to an uploaded media-library audio file (its mediaId) at creation. Copies the playable URL onto the lesson.

Response Body

`application/json`

curl -X POST "https://example.com/products/string/course/modules/string/lessons" \  -H "Content-Type: application/json" \  -d '{    "title": "string",    "type": "video"  }'

{  "lessonId": "string",  "moduleId": "string",  "title": "string"}

{  "error": "string"}

Bulk lesson status change

POST/products/{productId}/course/lessons/status

Authorization

bearerAuth

AuthorizationBearer <token>

API key from Dashboard → Integrations → API, MCP and CLI.

In: header

Path Parameters

productId*string

Product id

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

lessonIds*array<string>

status*LessonStatus

Value in

"draft"
"public"
"hidden"
"locked"

Response Body

`application/json`

curl -X POST "https://example.com/products/string/course/lessons/status" \  -H "Content-Type: application/json" \  -d '{    "lessonIds": [      "string"    ],    "status": "draft"  }'

{  "updated": 0}

{  "error": "string"}

Reorder modules

PUT/products/{productId}/course/modules/order

Authorization

bearerAuth

AuthorizationBearer <token>

API key from Dashboard → Integrations → API, MCP and CLI.

In: header

Path Parameters

productId*string

Product id

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

moduleIds*array<string>

Response Body

`application/json`

curl -X PUT "https://example.com/products/string/course/modules/order" \  -H "Content-Type: application/json" \  -d '{    "moduleIds": [      "string"    ]  }'

{  "courseId": "string"}

{  "error": "string"}

Reorder a module's lessons

PUT/products/{productId}/course/modules/{moduleId}/lessons/order

Authorization

bearerAuth

AuthorizationBearer <token>

API key from Dashboard → Integrations → API, MCP and CLI.

In: header

Path Parameters

productId*string

Product id

moduleId*string

Module id

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

lessonIds*array<string>

Response Body

`application/json`

curl -X PUT "https://example.com/products/string/course/modules/string/lessons/order" \  -H "Content-Type: application/json" \  -d '{    "lessonIds": [      "string"    ]  }'

{  "moduleId": "string"}

{  "error": "string"}

Quiz questions & settings

GET/products/{productId}/course/lessons/{lessonId}/quiz

Authorization

bearerAuth

AuthorizationBearer <token>

API key from Dashboard → Integrations → API, MCP and CLI.

In: header

Path Parameters

productId*string

Product id

lessonId*string

Lesson id

Response Body

`application/json`

curl -X GET "https://example.com/products/string/course/lessons/string/quiz"

{  "questions": [    {      "id": "string",      "question": "string",      "explanation": "string",      "points": 0,      "order": 0,      "mediaUrl": "string",      "source": {        "snippet": "string",        "startSeconds": 0      },      "type": "single_choice",      "options": [        {          "id": "string",          "text": "string",          "isCorrect": true,          "mediaUrl": "string"        }      ]    }  ],  "settings": {    "passingScore": 0,    "maxAttempts": 0,    "timeLimitSeconds": 0,    "shuffleQuestions": true,    "shuffleOptions": true,    "showCorrectAnswers": true,    "requirePassToProgress": true,    "questionCount": 0,    "totalPoints": 0  }}

{  "error": "string"}

Add a quiz question

POST/products/{productId}/course/lessons/{lessonId}/quiz/questions

Authorization

bearerAuth

AuthorizationBearer <token>

API key from Dashboard → Integrations → API, MCP and CLI.

In: header

Path Parameters

productId*string

Product id

lessonId*string

Lesson id

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

question*|||

Response Body

`application/json`

curl -X POST "https://example.com/products/string/course/lessons/string/quiz/questions" \  -H "Content-Type: application/json" \  -d '{    "question": {      "question": "string",      "type": "single_choice",      "options": [        {          "text": "string",          "isCorrect": true        }      ]    }  }'

{  "questionId": "string"}

{  "error": "string"}

Reorder quiz questions

PUT/products/{productId}/course/lessons/{lessonId}/quiz/questions/order

Authorization

bearerAuth

AuthorizationBearer <token>

API key from Dashboard → Integrations → API, MCP and CLI.

In: header

Path Parameters

productId*string

Product id

lessonId*string

Lesson id

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

orderedQuestionIds*array<string>

Every question id of the lesson, in the new display order.

Response Body

`application/json`

curl -X PUT "https://example.com/products/string/course/lessons/string/quiz/questions/order" \  -H "Content-Type: application/json" \  -d '{    "orderedQuestionIds": [      "string"    ]  }'

{  "reordered": true}

{  "error": "string"}

Replace a quiz question

PATCH/products/{productId}/course/lessons/{lessonId}/quiz/questions/{questionId}

Authorization

bearerAuth

AuthorizationBearer <token>

API key from Dashboard → Integrations → API, MCP and CLI.

In: header

Path Parameters

productId*string

Product id

lessonId*string

Lesson id

questionId*string

Quiz question id

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

question*|||

Response Body

`application/json`

curl -X PATCH "https://example.com/products/string/course/lessons/string/quiz/questions/string" \  -H "Content-Type: application/json" \  -d '{    "question": {      "question": "string",      "type": "single_choice",      "options": [        {          "text": "string",          "isCorrect": true        }      ]    }  }'

{  "updated": true}

{  "error": "string"}

Delete a quiz question (permanent)

DELETE/products/{productId}/course/lessons/{lessonId}/quiz/questions/{questionId}

Authorization

bearerAuth

AuthorizationBearer <token>

API key from Dashboard → Integrations → API, MCP and CLI.

In: header

Path Parameters

productId*string

Product id

lessonId*string

Lesson id

questionId*string

Quiz question id

Response Body

`application/json`

curl -X DELETE "https://example.com/products/string/course/lessons/string/quiz/questions/string"

{  "deleted": true}

{  "error": "string"}

Update quiz settings

PATCH/products/{productId}/course/lessons/{lessonId}/quiz/settings

Authorization

bearerAuth

AuthorizationBearer <token>

API key from Dashboard → Integrations → API, MCP and CLI.

In: header

Path Parameters

productId*string

Product id

lessonId*string

Lesson id

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

settings*

questionCount / totalPoints are denormalized by the CRUD routes and cannot be set here.

Response Body

`application/json`

curl -X PATCH "https://example.com/products/string/course/lessons/string/quiz/settings" \  -H "Content-Type: application/json" \  -d '{    "settings": {}  }'

{  "updated": true}

{  "error": "string"}

Was this article helpful?

Spotted something off? Tell us at support@zanfia.com.

Course structure

200application/json

4XXapplication/json

Lesson detail

200application/json

4XXapplication/json

Update a lesson

200application/json

4XXapplication/json

Delete a lesson (permanent)

200application/json

4XXapplication/json

Add a module

200application/json

4XXapplication/json

Update a module

200application/json

4XXapplication/json

Delete a module (permanent)

200application/json

4XXapplication/json

Add a lesson

200application/json

4XXapplication/json

Bulk lesson status change

200application/json

4XXapplication/json

Reorder modules

200application/json

4XXapplication/json

Reorder a module's lessons

200application/json

4XXapplication/json

Quiz questions & settings

200application/json

4XXapplication/json

Add a quiz question

200application/json

4XXapplication/json

Reorder quiz questions

200application/json

4XXapplication/json

Replace a quiz question

200application/json

4XXapplication/json

Delete a quiz question (permanent)

200application/json

4XXapplication/json

Update quiz settings

200application/json

4XXapplication/json

Related articles

API overview

Authentication and API keys

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`