Notify API reference

Notify API · Categories

patch/v1/workspaces/{workspace_id}/categories/{category_id}Auth

Update a category

Changes the fields you send. `defaults` merges per channel. The key cannot change.

Path parameters

workspace_id*string · uuid

Id of the workspace.

category_id*string · uuid

Id of the category.

Request body

namestring

Display name, shown in preference screens.

Example: "Security"

descriptionstring

What the category covers.

defaultsobject

Default per channel; a channel left out is `on`.

ordinalinteger

Sort order in preference screens (lower first).

android_channel_idstring

Android notification channel id for FCM pushes of this category; null means the category key.

transactionalboolean

Transactional categories (receipts, security notices) send email without a List-Unsubscribe header.

Response · 200 Updated.

id*string · uuid

Category id.

key*string

Stable key.

Example: "security"

name*string

Display name.

description*string

Description.

defaults*object

Default per channel.

ordinal*integer

Sort order.

android_channel_id*string

Android notification channel id (the key unless set).

transactional*boolean

Whether email goes out without List-Unsubscribe.

created_at*string · date-time

Created.

updated_at*string · date-time

Last change.

Example

Request

PATCH https://api.notify.productcraft.co/v1/workspaces/{workspace_id}/categories/{category_id}
Authorization: Bearer YOUR_TOKEN
Content-Type: application/json

{
  "name": "Security",
  "description": "string",
  "defaults": {},
  "ordinal": 0,
  "android_channel_id": "string",
  "transactional": false
}

Response

{
  "id": "00000000-0000-0000-0000-000000000000",
  "key": "security",
  "name": "string",
  "description": "string",
  "defaults": {},
  "ordinal": 0,
  "android_channel_id": "string",
  "transactional": false,
  "created_at": "2026-01-01T00:00:00.000Z",
  "updated_at": "2026-01-01T00:00:00.000Z"
}