NUnullplatform
Action Item Category

Create a category

Changed on

Create a new action item category. Categories classify action items and define governance rules.

post/action_item_category

Request

  • Base URL
    https://api.nullplatform.com
  • URL
    https://api.nullplatform.com/action_item_category
  • Auth
    HTTP bearer

Request body

nrnstring required

The NRN that owns this category.

namestring required

The display name of the category. Must be unique per NRN.

descriptionstring required

A description of what this category tracks.

parent_idstring

The ID of the parent category, for creating a subcategory. Max two levels of nesting.

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 (e.g., Dollars, Hours).

unit_symbolstring

Display symbol for the unit of value.

Example request

{
  "nrn": "organization=1:account=2",
  "name": "Security vulnerabilities",
  "description": "Tracks security issues found by automated scanners",
  "parent_id": "abc123def456",
  "color": "#E53E3E",
  "icon": "shield",
  "unit_name": "Dollars",
  "unit_symbol": "$",
  "config": {
    "max_deferral_days": 90,
    "max_deferral_count": 3
  }
}

Response

The created 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.

childrenCategory[] circular
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

  • 728d4df70ca1Revision changes
    • breaking

      the response's body type changed from no type to object for status

    • breaking

      the response property became optional for the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • info

      removed subschema #1 subschema #2 from the response body oneOf list for the response status

    • info

      media type application/json was changed to a more specific media type application/problem+json for the response status

    • info

      media type application/json was changed to a more specific media type application/problem+json for the response status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      response property message deprecated

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status