Skip to content
XOS Developers

notificationPreferences

Platform module · 4 operations

List notification preference rows

GET/notification-preferences

A per-kind, per-channel notification preference. Returns a cursor page of notification preference rows the caller may see. The default order is `created_at` ascending. Supports sparse fieldsets and the filter grammar.

Create a notification preference

POST/notification-preferences

A per-kind, per-channel notification preference. Creates a notification preference. Requires `Idempotency-Key`; a replay returns the original response. The organization is derived from the credential or the parent row, never from the body.

Get a notification preference

GET/notification-preferences/{id}

A per-kind, per-channel notification preference. Returns one notification preference with its `ETag`. A notification preference the caller may not see returns 404.

Update a notification preference

PATCH/notification-preferences/{id}

A per-kind, per-channel notification preference. Updates the fields sent; omitted fields are unchanged. Requires `If-Match` with the current `ETag`: a stale tag returns 412 and a missing tag returns 428.