Review UI Customizations

Customize notes behavior and UI elements for reviewers.

By default, when a reviewer approves a row, a "notes" pop-up appears, allowing the user to optionally add a note explaining their decision. When a reviewer rejects a row, the "notes" pop-up appears, and adding a note is required. This API allows you to customize this behavior. For example, you can choose to disable the pop-up when a row is approved and make the notes pop-up optional when a row is rejected.

Additionally, this API can enable the historical "Approve & Signoff" action in the reviewer experience when multiple rows are selected. Note: It is recommended that this feature remains disabled to ensure a more streamlined reviewer experience.

Parameters

accept_notes_behavior can be:

• NOTES_BEHAVIOR_UNKNOWN = 0

• NO_POP_UP = 1

• POP_UP_OPTIONAL = 2

• POP_UP_REQUIRED = 3

reject_notes_behavior can be:

• NOTES_BEHAVIOR_UNKNOWN = 0

• NO_POP_UP = 1

• POP_UP_OPTIONAL = 2

• POP_UP_REQUIRED = 3

approve_and_sign_off_button_behavior can be:

• HIDE_OR_SHOW_BEHAVIOR_UNKNOWN = 0

• SHOW = 1

• HIDE = 2

diff_dropdown_behavior can be:

• NORMAL = 1 (Enables all users to see decisions and access changes from previous reviews for the same configuration)

• ALWAYS_HIDE_FOR_ACCESS_REVIEWER_ROLE = 2 (Prevents users with the "Access Reviewer" role from accessing this option)

Example

{
    "value": {
        "diff_dropdown_behavior": "ALWAYS_HIDE_FOR_ACCESS_REVIEWER_ROLE",
        "accept_notes_behavior": "NO_POP_UP",
        "reject_notes_behavior": "POP_UP_REQUIRED",
        "approve_and_sign_off_button_behavior": "SHOW"
    }
}

Get Review UI Customizations

Get Review Customization Settings

get

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Header parameters

AcceptstringOptionalExample: application/json

Responses

200

OK

application/json

Responseobject

get

/api/private/workflows/access/global_settings/ui_customization_settings

HTTPcURLJavaScriptPython

GET /api/private/workflows/access/global_settings/ui_customization_settings HTTP/1.1
Host: {{baseurl}}
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

OK

{
  "value": {
    "diff_dropdown_behavior": "ALWAYS_HIDE_FOR_ACCESS_REVIEWER_ROLE",
    "accept_notes_behavior": "NO_POP_UP",
    "reject_notes_behavior": "POP_UP_REQUIRED",
    "approve_and_sign_off_button_behavior": "SHOW"
  }
}

Set Review UI Customizations

Set Review Customization Settings

put

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Header parameters

Content-TypestringOptionalExample: application/json

AcceptstringOptionalExample: application/json

Body

application/json

objectOptionalExample: {"value":{"diff_dropdown_behavior":"<integer>","accept_notes_behavior":"<integer>","reject_notes_behavior":"<integer>","approve_and_sign_off_button_behavior":"<integer>"}}

Responses

200

OK

application/json

Responseobject

put

/api/private/workflows/access/global_settings/ui_customization_settings

HTTPcURLJavaScriptPython

PUT /api/private/workflows/access/global_settings/ui_customization_settings HTTP/1.1
Host: {{baseurl}}
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 171

{
  "value": {
    "diff_dropdown_behavior": "<integer>",
    "accept_notes_behavior": "<integer>",
    "reject_notes_behavior": "<integer>",
    "approve_and_sign_off_button_behavior": "<integer>"
  }
}

200

OK

{
  "value": {
    "diff_dropdown_behavior": "ALWAYS_HIDE_FOR_ACCESS_REVIEWER_ROLE",
    "accept_notes_behavior": "NO_POP_UP",
    "reject_notes_behavior": "POP_UP_REQUIRED",
    "approve_and_sign_off_button_behavior": "SHOW"
  }
}