v1

latestOpenAPI 3.1.0Apache 2.02026-07-245981,1853.0 MB

Assessment Actions

Send Back Assessment

Use this API to send back a specific assessment to request more information from respondents. This action will move the assessment from the Under Review stage to the In Progress stage and comments will be provided to the respondent in an email notification.

post/api/assessment/v2/assessments/{id}/send-back

Path parameters

idstring uuid required

Unique identifier of the assessment to send back to the In Progress stage

Request body

emailCommentstring

Comment to be put in notification email.

sendBulkInfoRequestEmailboolean

Use this field to send notifications at the same time to the users to get more information on several questions.

editAllResponsesboolean

Use this field to all respondents to edit any question response when an assessment is sent back.

resetApproverReviewsboolean

When an assessment is sent back, the approver’s vote is either retained or removed depending on the setting.

reopenSectionIdsstring[]

Example request

{
  "emailComment": "Assessment needs additional data.",
  "reopenSectionIds": [
    "550e8400-e29b-41d4-a716-446655440000"
  ]
}