/v1/workspaces/{workspace_id}/notification-types/{type_id}/archiveAuthArchive a notification type
Archived types cannot be sent (`NOTIFICATION_TYPE_ARCHIVED`); history stays. Archiving twice is a no-op.
Path parameters
workspace_id*string · uuidId of the workspace.
type_id*string · uuidId of the type.
Response · 200 Archived.
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/{type_id}/archive
Authorization: Bearer YOUR_TOKENResponse
{
"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"
}