Docs
Add Block Response
POST /collaborators/{collaboratorId}/advances/{advanceId}/modules/{moduleId}/blocks/{blockId}
POST
/collaborators/{collaboratorId}/advances/{advanceId}/modules/{moduleId}/blocks/{blockId}Required Tokens
| Field | Type | Required | Description |
|---|---|---|---|
| Bearer | Authorization: Bearer <api-key> | Optional | Your API key. Pass it as the Bearer token on every request. |
Submits or updates a collaborator's response to a specific block within an advance module. A block can be a question or a resource request — supply the appropriate field and leave the other null.
Path Parameters
| Field | Type | Required | Description |
|---|---|---|---|
| collaboratorId | Guid | Required | The ID of the collaborator. |
| advanceId | Guid | Required | The ID of the advance. Set `{{advanceId}}` in your environment. |
| moduleId | Guid | Required | The ID of the advance module. Set `{{moduleId}}` in your environment or replace inline. |
| blockId | Guid | Required | The ID of the module template block being answered. Replace inline. |
Request Body
Provide either question or request — not both. Set the unused field to null.
Question response
| Field | Type | Required | Description |
|---|---|---|---|
| question.value | string | Required | The collaborator's answer text. |
Resource request response
| Field | Type | Required | Description |
|---|---|---|---|
| request.id | Guid | Required | ID of the existing request to update. Use `{{$guid}}` for a new response. |
| request.isDeleted | bool | Required | Pass `true` to retract the request. |
| request.asset | object | Optional | Asset details if this is an asset request. |
| request.asset.assetTypeId | Guid | Required | Asset type ID. |
| request.asset.providerId | Guid | Required | Provider ID. |
| request.asset.payorId | Guid | Required | Payor ID. |
| request.asset.properties | Prop[] | Optional | Asset-level properties (`{ templatePropertyId, value }`). |
| request.asset.subAssets | SubAsset[] | Optional | Sub-assets, each with their own `properties` array. |
| request.properties | Prop[] | Optional | Request-level properties (`{ templatePropertyId, value }`). |
Response
Returns 201 Created with the saved response object.
| Field | Type | Description |
|---|---|---|
| question | object | Saved question response if a question was submitted. Contains `id`, `advanceModuleId`, `moduleTemplateBlockId`, `questionTemplateId`, `taskId`, `taskStatusId`, `value`. |
| request | object | Saved resource request response if a request was submitted. Contains approval flags, `taskId`, `taskStatusId`, `asset`, and `properties`. |