Skip to main content
PUT
/
policies
/
{id}
curl --request PUT \
  --url "https://api.roe-ai.com/v1/policies/POLICY_ID/?organization_id=YOUR_ORG_ID" \
  --header "Authorization: Bearer YOUR_API_KEY" \
  --header "Content-Type: application/json" \
  --data '{
    "name": "Updated Policy Name",
    "description": "Updated policy description"
  }'

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "Updated Policy Name",
  "description": "Updated policy description",
  "organization_id": "org-12345678-1234-1234-1234-123456789012",
  "current_version_id": "456e7890-e89b-12d3-a456-426614174001",
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-01-21T09:00:00Z"
}

Documentation Index

Fetch the complete documentation index at: https://docs.roe-ai.com/llms.txt

Use this file to discover all available pages before exploring further.

Update metadata (name and description) of an existing policy. This does not modify the policy versions or content - use the Create Policy Version endpoint to add new content. This endpoint supports both PUT (full update) and PATCH (partial update) methods.

​
Path Parameters

ParameterTypeRequiredDescription
iduuidYesUUID of the policy to update

​
Query Parameters

ParameterTypeRequiredDescription
organization_iduuidYesUUID of the organization for access control

​
Request Body

FieldTypeRequired (PUT)Required (PATCH)Description
namestringYesNoNew name for the policy (max 255 characters)
descriptionstringNoNoNew description for the policy
curl --request PUT \
  --url "https://api.roe-ai.com/v1/policies/POLICY_ID/?organization_id=YOUR_ORG_ID" \
  --header "Authorization: Bearer YOUR_API_KEY" \
  --header "Content-Type: application/json" \
  --data '{
    "name": "Updated Policy Name",
    "description": "Updated policy description"
  }'

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "Updated Policy Name",
  "description": "Updated policy description",
  "organization_id": "org-12345678-1234-1234-1234-123456789012",
  "current_version_id": "456e7890-e89b-12d3-a456-426614174001",
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-01-21T09:00:00Z"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
id
string<uuid>
required

Query Parameters

​
organization_id
string<uuid>

Organization ID. This is required for access control. It can be provided via query or request body depending on the endpoint.

Body

application/json

Serializer for updating policy metadata (name, description)

​
name
string
required
Required string length: 1 - 255
​
description
string

Response

200 - application/json

Serializer for updating policy metadata (name, description)

​
id
string<uuid>
required
read-only
​
name
string
required
Maximum string length: 255
​
organization_id
string<uuid>
required
read-only
​
current_version_id
string<uuid> | null
required
read-only
​
created_at
string<date-time>
required
read-only
​
updated_at
string<date-time>
required
read-only
​
description
string