Docs

Update Advance Module

PUT /collaborators/{collaboratorId}/advances/{advanceId}/modules/{moduleId}

PUT/collaborators/{collaboratorId}/advances/{advanceId}/modules/{moduleId}

Required Tokens

FieldTypeRequiredDescription
BearerAuthorization: Bearer <api-key>OptionalYour API key. Pass it as the Bearer token on every request.

Updates configuration for an advance module — its sort order, due date, required flag, task tracking, and optional reviewer.

Path Parameters

FieldTypeRequiredDescription
collaboratorIdGuidRequiredThe ID of the collaborator.
advanceIdGuidRequiredThe ID of the advance. Set `{{advanceId}}` in your environment.
moduleIdGuidRequiredThe ID of the module instance to update. Set `{{moduleId}}` in your environment or replace inline.

Request Body

FieldTypeRequiredDescription
indexintRequiredSort position of this module within the advance.
dueDateDateTimeRequiredUpdated due date.
isRequiredboolRequiredWhether completion is required.
isTaskTrackedboolRequiredWhether module progress is tracked as a task.
reviewerUserIdGuid?OptionalUser ID of the reviewer. Pass `null` to remove.

Response

Returns 200 OK with an empty body on success.