Skip to content
Rules/
/
Update category
Last updated

Update category

🔨 In Development — This section is still being developed and may change.
Modify an existing rule category's properties, such as display name, description, priority range, or metadata. This endpoint supports partial updates - only the fields you want to change need to be included.
PATCHhttps://api.freddy.aitronos.com/v1/organizations/{organization_id}/rules/categories/{category_id}

Update category properties while maintaining its ID and core structure. Use this to modify category settings, update descriptions, or adjust priority ranges as your organization's needs evolve.

Path Parameters

organizationId string required

The organization identifier that owns the category.

category_id string required

The unique identifier of the category to update. This is the name field from the category object.

Request Body

display_name string optional

Updated human-readable name for the category.

description string optional

Updated description explaining the category's purpose.

priority_range string optional

Updated priority range recommendation (format: "min-max").

recommended_limit integer optional

Updated recommended character limit for rules in this category.

metadata object optional

Updated custom key-value pairs for tagging and organization.

Returns

A RuleResponse object containing the API response data.

Bash
curl -X PATCH "https://api.freddy.aitronos.com/v1/organizations/org_123/rules/categories/compliance" \
-H "Authorization: Bearer $FREDDY_API_KEY" \
-H "Content-Type: application/json" \
-d '{
  "description": "Enhanced compliance rules covering GDPR, CCPA, and industry-specific regulations",
  "recommended_limit": 6000,
  "priority_range": "95-100",
  "metadata": {
    "department": "legal",
    "requires_approval": "true",
    "last_reviewed": "2024-10-01"
  }
}'

Response

{
  "id": "cat_compliance_001",
  "name": "compliance",
  "display_name": "Compliance & Legal",
  "description": "Enhanced compliance rules covering GDPR, CCPA, and industry-specific regulations",
  "priority_range": "95-100",
  "recommended_limit": 6000,
  "rule_count": 12,
  "is_default": false,
  "is_active": true,
  "organizationId": "org_xyz789",
  "createdBy": "user_123",
  "createdAt": "2024-10-04T12:00:00Z",
  "updatedAt": "2024-10-30T16:45:00Z",
  "metadata": {
    "department": "legal",
    "requires_approval": "true",
    "last_reviewed": "2024-10-01"
  }
}
Previous page
Next page