Update a notification

Módulo Platform

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.

Requiere la capacidad inbox.notifications.write.
Alcances de OAuth: inbox.
Envía If-Match con el ETag que leíste. Una etiqueta desactualizada devuelve 412; si falta, devuelve 428.
Estados de error: 400, 401, 404, 412, 422, 428, 429. Los errores son detalles de problema RFC 9457.

Parámetros de ruta y de consulta

notifications.update: Parámetros de ruta y de consulta
Campo	Tipo	Obligatorio	Descripción
id	string (uuid)	Sí	Identifier of the notification.

Cuerpo de la solicitud: NotificationUpdate

notifications.update: NotificationUpdate
Campo	Tipo	Obligatorio	Descripción
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"
}

Respuesta 200: Notification

notifications.update: Notification
Campo	Tipo	Obligatorio	Descripción
id	string (uuid)	Sí	Identifier of the notification.
org_id	string (uuid)	Sí	Identifier of the owning organization, derived from the parent row and never accepted from the caller.
created_at	string (date-time)	Sí	When the row was created.
created_by	string (uuid) \| null	Sí	Identifier of the person who created the row; null when a seed, platform or system process created it.
updated_at	string (date-time)	Sí	When the row was last updated.
updated_by	string (uuid) \| null	Sí	Identifier of the person who last updated the row; null when a seed, platform or system process updated it.
kind	string	Sí	Notification kind from `notification-kinds.yaml`.Restricciones: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
recipient_person_id	string (uuid)	Sí	Identifier of the person the notification is for.
read_at	string (date-time) \| null	Sí	When it was read.
actor_person_id	string (uuid) \| null	Sí	Identifier of the person whose action caused it, when one did.
subject_table	string \| null	Sí	Table of the record it is about.Restricciones: pattern ^[a-z][a-z0-9_]*$
subject_id	string (uuid) \| null	Sí	Identifier of the record it is about.
project_id	string (uuid) \| null	Sí	Identifier of the project of the record, when it belongs to one.
message_args	object	Sí	ICU message arguments for the kind's catalog messages, such as a record title.
archived_at	string (date-time) \| null	Sí	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"
}

Ejemplos de código

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