/v1/workspaces/{workspace_id}/categoriesAuthCreate a category
At most 50 categories per workspace during the preview. Channels left out of `defaults` are `on`.
Path parameters
workspace_id*string · uuidId of the workspace.
Headers
Idempotency-KeystringA key (1..256 chars, [A-Za-z0-9._:-]) makes retries safe: a replay returns the original response for 24 h.
Request body
namestringDisplay name, shown in preference screens.
Example: "Security"
descriptionstringWhat the category covers.
defaultsobjectDefault per channel; a channel left out is `on`.
ordinalintegerSort order in preference screens (lower first).
android_channel_idstringAndroid notification channel id for FCM pushes of this category; null means the category key.
transactionalbooleanTransactional categories (receipts, security notices) send email without a List-Unsubscribe header.
key*stringStable key, unique in the workspace: must start with a-z and use only a-z 0-9 _ . - (at most 100 characters).
Example: "security"
Response · 201 Created.
id*string · uuidCategory id.
key*stringStable key.
Example: "security"
name*stringDisplay name.
description*stringDescription.
defaults*objectDefault per channel.
ordinal*integerSort order.
android_channel_id*stringAndroid notification channel id (the key unless set).
transactional*booleanWhether email goes out without List-Unsubscribe.
created_at*string · date-timeCreated.
updated_at*string · date-timeLast change.
Example
Request
POST https://api.notify.productcraft.co/v1/workspaces/{workspace_id}/categories
Authorization: Bearer YOUR_TOKEN
Content-Type: application/json
{
"name": "Security",
"description": "string",
"defaults": {},
"ordinal": 0,
"android_channel_id": "string",
"transactional": false,
"key": "security"
}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"
}