Create Category

Creates a new category.

post

Body

application/jsontext/jsonapplication/*+json

CreateCategoryDto

namestringOptional

descriptionstringOptional

optOutAllowedbooleanOptional

notestring | nullableOptional

deleteAllowedboolean | nullableOptional

Responses

201

Created

application/json

400

Bad Request

application/json

post

/public/v1/notifications/categories

HTTPcURLJavaScriptPython

POST /public/v1/notifications/categories HTTP/1.1
Host: api.platform.softwareone.com
Content-Type: application/json
Accept: */*
Content-Length: 92

{
  "name": "text",
  "description": "text",
  "optOutAllowed": true,
  "note": "text",
  "deleteAllowed": true
}

application/jsontext/jsonapplication/*+json

{
  "id": "text",
  "audit": {
    "created": {
      "at": "2025-12-19T13:03:39.429Z",
      "by": {}
    },
    "updated": {
      "at": "2025-12-19T13:03:39.429Z",
      "by": {}
    },
    "published": {
      "at": "2025-12-19T13:03:39.429Z",
      "by": {}
    },
    "unpublished": {
      "at": "2025-12-19T13:03:39.429Z",
      "by": {}
    },
    "deleted": {
      "at": "2025-12-19T13:03:39.429Z",
      "by": {}
    }
  },
  "$meta": {
    "omitted": [
      "text"
    ]
  },
  "description": "text",
  "optOutAllowed": true,
  "status": "text",
  "name": "text",
  "note": "text",
  "deleteAllowed": true,
  "icon": "text",
  "statistics": {
    "month": {
      "bounced": 1,
      "complained": 1,
      "discarded": 1,
      "failed": 1,
      "sent": 1,
      "total": 1
    },
    "today": {
      "bounced": 1,
      "complained": 1,
      "discarded": 1,
      "failed": 1,
      "sent": 1,
      "total": 1
    },
    "week": {
      "bounced": 1,
      "complained": 1,
      "discarded": 1,
      "failed": 1,
      "sent": 1,
      "total": 1
    }
  },
  "lastUsed": "2025-12-19T13:03:39.429Z"
}