Sign in
Action Item Category

Update a category

Update an action item category. Only the fields included in the request body are updated.

patch/action_item_category/{id}

Path parameters

idstring required

The category ID.

Request body

namestring

The display name of the category.

descriptionstring

A description of what this category tracks.

colorstring

Hex color code for the category in the UI.

iconstring

Icon name for the category in the UI.

unit_namestring

Display name for the unit of value.

unit_symbolstring

Display symbol for the unit of value.

status'active' | 'inactive'

The category status.

Example request

{
  "name": "Security vulnerabilities",
  "description": "Tracks security issues found by automated scanners",
  "color": "#E53E3E",
  "icon": "shield",
  "unit_name": "Dollars",
  "unit_symbol": "$",
  "status": "active",
  "config": {
    "max_deferral_days": 90,
    "max_deferral_count": 3
  }
}

Response

The updated category.

idstring

The unique category ID.

slugstring

Auto-generated URL-friendly slug.

nrnstring

The NRN that owns this category.

parent_idstring

The parent category ID, if this is a subcategory.

namestring

The display name.

descriptionstring

A description of the category.

colorstring

Hex color code.

iconstring

Icon name.

unit_namestring

Display name for the unit of value.

unit_symbolstring

Display symbol for the unit of value.

status'active' | 'inactive'

The category status.

created_atstring date-time

Creation timestamp.

updated_atstring date-time

Last update timestamp.

Example response

{
  "id": "abc123def456",
  "slug": "security-vulnerabilities",
  "nrn": "organization=1:account=2",
  "name": "Security vulnerabilities",
  "description": "Tracks security issues found by automated scanners",
  "color": "#E53E3E",
  "icon": "shield",
  "unit_name": "Dollars",
  "unit_symbol": "$",
  "config": {
    "max_deferral_days": 90,
    "max_deferral_count": 3
  },
  "status": "active",
  "created_at": "2026-04-01T10:00:00.000Z",
  "updated_at": "2026-04-01T10:00:00.000Z"
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.