Update a notification
Platform module
PATCH/notifications/{id}notifications.update
A notification for the caller. 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 inbox.notifications.write.
- OAuth scopes: inbox.
- 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
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the notification. |
Request body: NotificationUpdate
| Field | Type | Required | Description |
|---|---|---|---|
| read_at | string (date-time) | null | No | When it was read. |
| archived_at | string (date-time) | null | No | When the recipient archived it. |
{
"read_at": "2026-10-08T14:30:00Z",
"archived_at": "2026-10-08T14:30:00Z"
}Response 200: Notification
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the notification. |
| org_id | string (uuid) | Yes | Identifier of the owning organization, derived from the parent row and never accepted from the caller. |
| created_at | string (date-time) | Yes | When the row was created. |
| created_by | string (uuid) | null | Yes | Identifier of the person who created the row; null when a seed, platform or system process created it. |
| updated_at | string (date-time) | Yes | When the row was last updated. |
| updated_by | string (uuid) | null | Yes | Identifier of the person who last updated the row; null when a seed, platform or system process updated it. |
| kind | string | Yes | Notification kind from `notification-kinds.yaml`.Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$ |
| recipient_person_id | string (uuid) | Yes | Identifier of the person the notification is for. |
| read_at | string (date-time) | null | Yes | When it was read. |
| actor_person_id | string (uuid) | null | Yes | Identifier of the person whose action caused it, when one did. |
| subject_table | string | null | Yes | Table of the record it is about.Constraints: pattern ^[a-z][a-z0-9_]*$ |
| subject_id | string (uuid) | null | Yes | Identifier of the record it is about. |
| project_id | string (uuid) | null | Yes | Identifier of the project of the record, when it belongs to one. |
| message_args | object | Yes | ICU message arguments for the kind's catalog messages, such as a record title. |
| archived_at | string (date-time) | null | Yes | When the recipient archived it. |
{
"id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"org_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"created_at": "2026-10-08T14:30:00Z",
"created_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"updated_at": "2026-10-08T14:30:00Z",
"updated_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"kind": "timesheet.approved",
"recipient_person_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"read_at": "2026-10-08T14:30:00Z",
"actor_person_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"subject_table": "records",
"subject_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"message_args": {
"type": "doc"
},
"archived_at": "2026-10-08T14:30:00Z"
}Code samples
curl -X PATCH "$XOS_BASE_URL/notifications/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 '{"read_at":"2026-10-08T14:30:00Z","archived_at":"2026-10-08T14:30:00Z"}'const { data, etag } = await xos.notifications.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {
"read_at": "2026-10-08T14:30:00Z",
"archived_at": "2026-10-08T14:30:00Z"
}, { ifMatch: etag });response = xos.notifications.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {"read_at": "2026-10-08T14:30:00Z", "archived_at": "2026-10-08T14:30:00Z"}, if_match=etag)xos notifications update 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f --data '{"read_at":"2026-10-08T14:30:00Z","archived_at":"2026-10-08T14:30:00Z"}' --if-match auto