Update Category

Updates a category.

put

Path parameters

idstringRequired

Body

application/jsontext/jsonapplication/*+json

namestringOptional

shortDescriptionstringOptional

descriptionstring | nullableOptional

optOutAllowedbooleanOptional

notestringOptional

deleteAllowedbooleanOptional

Responses

201

Created

application/json

400

Bad Request

application/json

404

Not Found

application/json

put

HTTPcURLJavaScriptPython

PUT /public/v1/notifications/categories/{id} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 118

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

application/jsontext/jsonapplication/*+json

{
  "id": "text",
  "audit": {
    "created": {
      "at": "2025-06-19T15:05:19.014Z",
      "by": {
        "0": "[",
        "1": "C",
        "2": "i",
        "3": "r",
        "4": "c",
        "5": "u",
        "6": "l",
        "7": "a",
        "8": "r",
        "9": " ",
        "10": "R",
        "11": "e",
        "12": "f",
        "13": "e",
        "14": "r",
        "15": "e",
        "16": "n",
        "17": "c",
        "18": "e",
        "19": "]"
      }
    },
    "updated": {
      "at": "2025-06-19T15:05:19.014Z",
      "by": {
        "0": "[",
        "1": "C",
        "2": "i",
        "3": "r",
        "4": "c",
        "5": "u",
        "6": "l",
        "7": "a",
        "8": "r",
        "9": " ",
        "10": "R",
        "11": "e",
        "12": "f",
        "13": "e",
        "14": "r",
        "15": "e",
        "16": "n",
        "17": "c",
        "18": "e",
        "19": "]"
      }
    },
    "published": {
      "at": "2025-06-19T15:05:19.014Z",
      "by": {
        "0": "[",
        "1": "C",
        "2": "i",
        "3": "r",
        "4": "c",
        "5": "u",
        "6": "l",
        "7": "a",
        "8": "r",
        "9": " ",
        "10": "R",
        "11": "e",
        "12": "f",
        "13": "e",
        "14": "r",
        "15": "e",
        "16": "n",
        "17": "c",
        "18": "e",
        "19": "]"
      }
    },
    "unpublished": {
      "at": "2025-06-19T15:05:19.014Z",
      "by": {
        "0": "[",
        "1": "C",
        "2": "i",
        "3": "r",
        "4": "c",
        "5": "u",
        "6": "l",
        "7": "a",
        "8": "r",
        "9": " ",
        "10": "R",
        "11": "e",
        "12": "f",
        "13": "e",
        "14": "r",
        "15": "e",
        "16": "n",
        "17": "c",
        "18": "e",
        "19": "]"
      }
    },
    "deleted": {
      "at": "2025-06-19T15:05:19.014Z",
      "by": {
        "0": "[",
        "1": "C",
        "2": "i",
        "3": "r",
        "4": "c",
        "5": "u",
        "6": "l",
        "7": "a",
        "8": "r",
        "9": " ",
        "10": "R",
        "11": "e",
        "12": "f",
        "13": "e",
        "14": "r",
        "15": "e",
        "16": "n",
        "17": "c",
        "18": "e",
        "19": "]"
      }
    }
  },
  "$meta": {
    "omitted": [
      "text"
    ]
  },
  "description": "text",
  "optOutAllowed": true,
  "shortDescription": "text",
  "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-06-19T15:05:19.014Z"
}