Policies

Update a policy

Changed on

Updates an existing policy. Only provided fields are updated. The last_updated_by and last_updated_at are set automatically from the JWT token. If assigned_reviewer_ids is provided, the reviewer list is fully replaced.

put/policies/{id}

Request

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

Path parameters

idinteger required
Example:42

Numeric ID of the policy

Request body

titlestring

Updated policy title

content_htmlstring

Updated policy content as HTML

statusstring

Updated policy status

tagsstring[]

Replacement tag list (must be from the allowed tag list)

next_review_datestring date-time nullable

Updated next review date

assigned_reviewer_idsinteger[]

Replacement reviewer list (fully replaces existing reviewers)

Response

Policy updated successfully

messagestring

Example response

{
  "message": "Accepted",
  "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