Policies

Request review for a policy

Changed on

Sets the policy review status to pending_review and sends in-app notifications to each specified reviewer.

post/policies/{id}/review/request

Request

  • Base URL
    /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /api/policies/{id}/review/request
  • Auth
    HTTP bearer

Path parameters

idinteger required
Example:42

Numeric ID of the policy

Request body

reviewer_idsinteger[] required

List of user IDs to request review from

messagestring

Optional message to include in the review request notification

Example request

{
  "reviewer_ids": [
    2,
    5,
    8
  ],
  "message": "Please review the updated data governance section."
}

Response

Review requested successfully; returns the updated policy

messagestring

Example response

{
  "message": "OK",
  "data": {
    "id": 42,
    "organization_id": 1,
    "title": "AI Ethics Policy",
    "content_html": "<h1>AI Ethics Policy</h1><p>...</p>",
    "status": "draft",
    "author_id": 1,
    "last_updated_by": 1,
    "assigned_reviewer_ids": [
      2,
      5
    ]
  }
}

Changes