Mandatory Due Date Settings

Configure whether due dates are required when creating or editing access reviews.

Configure whether due dates are required when creating or editing access reviews. When enabled, review creators must specify a due date before creating a review.

This setting can be configured globally or per-workflow. When a workflow-specific setting is applied, it overrides the global setting for reviews created from that Review Configuration.

Parameters

The setting accepts an object with boolean fields for each review level:

Field
Type
Description

mandatory_for_first_level

boolean

Require due date for first-level (primary) reviews

mandatory_for_second_level

boolean

Require due date for second-level reviews

mandatory_for_third_level

boolean

Require due date for third-level reviews

Examples

Enable mandatory due dates for first-level reviews only:

{
    "value": {
        "mandatory_for_first_level": true,
        "mandatory_for_second_level": false,
        "mandatory_for_third_level": false
    }
}

Enable mandatory due dates for all review levels:

Example cURL request (global setting):

Example cURL request (workflow-specific setting):

Get Mandatory Due Date Settings

Get Mandatory Due Date Settings

get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
workflow_idstringOptional

Optional workflow ID to get workflow-specific settings

Example: 8ae1c414-3a76-46cb-950a-925316b3f264
Header parameters
AcceptstringOptionalExample: application/json
Responses
chevron-right
200

OK

application/json
get
/api/private/workflows/access/global_settings/mandatory_due_date_for_review_settings
200

OK

Set Mandatory Due Date Settings

Set Mandatory Due Date Settings

put
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Header parameters
Content-TypestringOptionalExample: application/json
AcceptstringOptionalExample: application/json
Body
workflow_idstringOptional

Optional workflow ID for workflow-specific settings

Responses
chevron-right
200

OK

application/json
objectOptional
put
/api/private/workflows/access/global_settings/mandatory_due_date_for_review_settings
200

OK

Last updated

Was this helpful?