Memos unofficial
PATCH/api/v1/users/{user}/notifications/{notification}

Update a user notification

Updates a user's notification. Use updateMask to select the fields to change; the request body schema exposes status as an editable field, while the other defined fields are read-only.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

3 parameters · 9 body fields
userstringrequired
The identifier of the user who owns the notification.
notificationstringrequired
The identifier of the notification to update.
updateMaskstringoptional
A field mask specifying which notification fields to update.

Notification fields for the update. The defined fields other than status are read-only.

namestringoptional
The resource name of the notification. Format: users/{user}/notifications/{notification}
senderstringoptional
The sender of the notification. Format: users/{user}
senderUserobjectoptional
The sender user details.
statusstringoptional
The status of the notification.
Allowed:STATUS_UNSPECIFIEDUNREADARCHIVED
createTimestringoptional
The creation timestamp.
typestringoptional
The type of the notification.
Allowed:TYPE_UNSPECIFIEDMEMO_COMMENTMEMO_MENTIONSPACE_INVITATION
memoCommentobjectoptional
Memo comment details associated with the notification; read-only.
memoMentionobjectoptional
Memo mention details associated with the notification; read-only.
spaceInvitationobjectoptional
Space invitation details associated with the notification; read-only.

2 status codes
200Returns the notification object, including its status and associated notification details.
namestringoptional
The resource name of the notification. Format: users/{user}/notifications/{notification}
senderstringoptional
The sender of the notification. Format: users/{user}
senderUserobjectoptional
The sender user details.
statusstringoptional
The status of the notification.
Allowed:STATUS_UNSPECIFIEDUNREADARCHIVED
createTimestringoptional
The creation timestamp.
typestringoptional
The type of the notification.
Allowed:TYPE_UNSPECIFIEDMEMO_COMMENTMEMO_MENTIONSPACE_INVITATION
memoCommentobjectoptional
memoMentionobjectoptional
spaceInvitationobjectoptional
defaultDefault error response
codeintegeroptional
The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].
messagestringoptional
A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.
detailsarray<object>optional
A list of messages that carry the error details. There is a common set of message types for APIs to use.

Error handling

The user path parameter identifies the notification's user, and the notification path parameter identifies the notification to update. status must be STATUS_UNSPECIFIED, UNREAD, or ARCHIVED; use updateMask to select fields for the update.