Docs
Add Advance Module
POST /collaborators/{collaboratorId}/advances/{advanceId}/modules
POST
/collaborators/{collaboratorId}/advances/{advanceId}/modulesRequired Tokens
| Field | Type | Required | Description |
|---|---|---|---|
| Bearer | Authorization: Bearer <api-key> | Optional | Your API key. Pass it as the Bearer token on every request. |
Adds a module to an existing advance. The module is seeded from a module template which defines its blocks (questions, requests, content).
Path Parameters
| Field | Type | Required | Description |
|---|---|---|---|
| collaboratorId | Guid | Required | The ID of the collaborator. |
| advanceId | Guid | Required | The ID of the advance to add the module to. Set `{{advanceId}}` in your environment. |
Request Body
| Field | Type | Required | Description |
|---|---|---|---|
| moduleTemplateId | Guid | Required | ID of the module template to instantiate. |
| dueDate | DateTime | Required | Due date for completing this module. |
| isRequired | bool | Required | Whether collaborator must complete this module. |
Response
Returns 201 Created with an empty body on success.