/v1/workspaces/{workspace_id}/notification-typesAuthCreate a notification type
At most 200 types per workspace during the preview. Add templates with `PUT …/templates/{channel}/{locale}`, or create the type and its templates in one call with `PUT /notification-types/by-key/{key}`.
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.
Example: "Invoice paid"
descriptionstringWhat the notification is for.
category_keystringKey of the category the type belongs to.
Example: "billing"
routingobjectWhich channels are tried, and in what order.
criticalbooleanCritical types (security notices) ignore opt-outs and quiet hours and use their own rate budget. They never bypass hard bounces, spam complaints or Mail suppression.
ttl_secondsintegerDeliveries not sent within this many seconds expire.
default_localestringLocale used when the recipient locale has no template (BCP 47).
Example: "en"
email_quiet_hoursbooleanHold email during the recipient quiet hours too (push is always held, the inbox never).
throttleobjectPer-recipient cap for this type; null removes it.
key*stringKey used when sending, unique in the workspace: must start with a-z and use only a-z 0-9 _ . - (at most 100 characters).
Example: "invoice.paid"
Response · 201 Created.
id*string · uuidType id.
key*stringKey used when sending.
Example: "invoice.paid"
name*stringDisplay name.
description*stringDescription.
category_id*string · uuidCategory id.
category_key*stringCategory key.
routing*objectRouting.
critical*booleanWhether the type is critical.
ttl_seconds*integerTime to live of a delivery, in seconds.
default_locale*stringFallback locale.
email_quiet_hours*booleanWhether email is held during quiet hours.
throttle*objectPer-recipient cap.
archived_at*string · date-timeWhen archived; archived types cannot be sent.
version*integerIncreases on every change of the type.
templates*arrayThe templates (bodies under `…/templates/{channel}/{locale}`).
created_at*string · date-timeCreated.
updated_at*string · date-timeLast change.
Example
Request
POST https://api.notify.productcraft.co/v1/workspaces/{workspace_id}/notification-types
Authorization: Bearer YOUR_TOKEN
Content-Type: application/json
{
"name": "Invoice paid",
"description": "string",
"category_key": "billing",
"routing": {},
"critical": false,
"ttl_seconds": 0,
"default_locale": "en",
"email_quiet_hours": false,
"throttle": {},
"key": "invoice.paid"
}Response
{
"id": "00000000-0000-0000-0000-000000000000",
"key": "invoice.paid",
"name": "string",
"description": "string",
"category_id": "00000000-0000-0000-0000-000000000000",
"category_key": "string",
"routing": {},
"critical": false,
"ttl_seconds": 0,
"default_locale": "string",
"email_quiet_hours": false,
"throttle": {},
"archived_at": "2026-01-01T00:00:00.000Z",
"version": 0,
"templates": [
{
"channel": {},
"locale": "pt-PT",
"version": 0,
"updated_at": "2026-01-01T00:00:00.000Z"
}
],
"created_at": "2026-01-01T00:00:00.000Z",
"updated_at": "2026-01-01T00:00:00.000Z"
}