API Docs / Schemas / ReviewDocumentRequestResponseRequest

ReviewDocumentRequestResponseRequest

Request DTO for reviewing (accepting or rejecting) a document request response

Properties

Name Type Description
acceptedboolean

Whether to accept the submission. If false, NextAction determines what happens.

Whether to accept the submission. If false, NextAction determines what happens.

reviewNotestring

Note from the reviewer explaining the decision

Note from the reviewer explaining the decision

nextActionenum

Reopen ReopenClearDocs

Reopen ReopenClearDocs

makeDocumentsAvailableboolean

When accepting, whether to publish the request's documents to the main Documents list.
Defaults to true. Only used when Accepted is true.

When accepting, whether to publish the request's documents to the main Documents list.
Defaults to true. Only used when Accepted is true.

portalFolderPathstring

When publishing, the portal folder path where the documents should appear.
Null or omitted means the client root. Only used when MakeDocumentsAvailable is true.
Format: "folderId:FolderName/folderId:FolderName".

When publishing, the portal folder path where the documents should appear.
Null or omitted means the client root. Only used when MakeDocumentsAvailable is true.
Format: "folderId:FolderName/folderId:FolderName".

JSON Example

{
  "accepted": false,
  "reviewNote": "string",
  "nextAction": "Reopen",
  "makeDocumentsAvailable": false,
  "portalFolderPath": "string"
}

Used By Operations