Skip to main content
PATCH
/
v1
/
policies
/
{policy_id}
Update Policy
curl --request PATCH \
  --url https://api.example.com/v1/policies/{policy_id} \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "category": "privacy",
  "status": "draft",
  "source_text": "<string>",
  "tags": [
    "<string>"
  ]
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "team_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "category": "privacy",
  "created_at": 123,
  "updated_at": 123,
  "created_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "description": "<string>",
  "status": "draft",
  "source_text": "<string>",
  "file_path": "<string>",
  "file_name": "<string>",
  "file_type": "<string>",
  "file_size_bytes": 123,
  "converted_file_path": "<string>",
  "is_preset": false,
  "preset_source": "<string>",
  "tags": [
    "<string>"
  ]
}

Path Parameters

​
policy_id
string<uuid>
required

Body

application/json

Request model for updating a policy. All fields are optional.

​
name
string | null
Required string length: 1 - 255
​
description
string | null
​
category
enum<string> | null

Category of policy document.

Available options:
privacy,
ethics,
security,
compliance,
operational,
brand,
custom
​
status
enum<string> | null

Status of a policy document.

Available options:
draft,
active,
archived
​
source_text
string | null
​
tags
string[] | null

Response

Successful Response

Domain model for Policy document.

​
id
string<uuid>
required
​
team_id
string<uuid>
required
​
name
string
required
​
category
enum<string>
required

Category of policy document.

Available options:
privacy,
ethics,
security,
compliance,
operational,
brand,
custom
​
created_at
integer
required
​
updated_at
integer
required
​
created_by
string<uuid>
required
​
description
string | null
​
status
enum<string>
default:draft

Status of a policy document.

Available options:
draft,
active,
archived
​
source_text
string | null
​
file_path
string | null
​
file_name
string | null
​
file_type
string | null
​
file_size_bytes
integer | null
​
converted_file_path
string | null
​
is_preset
boolean
default:false
​
preset_source
string | null
​
tags
string[] | null
Last modified on April 21, 2026