Update a notification preference

Platform module

PATCH/notification-preferences/{id}notificationPreferences.update

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.

Requires the capability me.notifications.write.
OAuth scopes: me.
Send If-Match with the ETag you read. A stale tag returns 412; a missing tag returns 428.
Error statuses: 400, 401, 404, 412, 422, 428, 429. Errors are RFC 9457 problem details.

Path and query parameters

notificationPreferences.update: Path and query parameters
Field	Type	Required	Description
id	string (uuid)	Yes	Identifier of the notification preference.

Request body: NotificationPreferenceUpdate

notificationPreferences.update: NotificationPreferenceUpdate
Field	Type	Required	Description
enabled	boolean	No	Whether the channel is on for the kind.

{
  "enabled": true
}

Response 200: NotificationPreference

notificationPreferences.update: NotificationPreference
Field	Type	Required	Description
id	string (uuid)	Yes	Identifier of the notification preference.
created_at	string (date-time)	Yes	When the row was created.
updated_at	string (date-time)	Yes	When the row was last updated.
channel	"In App" \| "Email" \| "SMS" \| "Push"	Yes	Delivery channel.
enabled	boolean	Yes	Whether the channel is on for the kind.
membership_id	string (uuid)	Yes	Identifier of the membership whose preference this is; preferences are per org.
category_code	string	Yes	Notification category.Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$

{
  "id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "created_at": "2026-10-08T14:30:00Z",
  "updated_at": "2026-10-08T14:30:00Z",
  "channel": "In App",
  "enabled": true,
  "membership_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "category_code": "approvals"
}

Code samples

curl -X PATCH "$XOS_BASE_URL/notification-preferences/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H 'If-Match: W/"etag-from-your-last-read"' \
  -H "Content-Type: application/json" \
  -d '{"enabled":true}'

const { data, etag } = await xos.notificationPreferences.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {
    "enabled": true
  }, { ifMatch: etag });

response = xos.notification_preferences.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {"enabled": True}, if_match=etag)

xos notification-preferences update 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f --data '{"enabled":true}' --if-match auto