UserNotification

Where this schema is used

These links are derived from direct references in the protocol snapshot. Follow the calling operation for authentication, accepted fields and runtime behavior; a reusable resource schema is not by itself a complete write request.

• PATCHUpdate User Notification/api/v1/users/{user}/notifications/{notification}

Referenced by these component schemas:

• ListUserNotificationsResponse

Shape and fields

object

Complete schema

Use this complete JSON definition for constraints and nested structure. A field's presence here does not mean it is writable by every caller.

{
  "type": "object",
  "properties": {
    "name": {
      "readOnly": true,
      "type": "string",
      "description": "The resource name of the notification.\n Format: users/{user}/notifications/{notification}"
    },
    "sender": {
      "readOnly": true,
      "type": "string",
      "description": "The sender of the notification.\n Format: users/{user}"
    },
    "senderUser": {
      "readOnly": true,
      "allOf": [
        {
          "$ref": "#/components/schemas/User"
        }
      ],
      "description": "The sender user details."
    },
    "status": {
      "enum": [
        "STATUS_UNSPECIFIED",
        "UNREAD",
        "ARCHIVED"
      ],
      "type": "string",
      "description": "The status of the notification.",
      "format": "enum"
    },
    "createTime": {
      "readOnly": true,
      "type": "string",
      "description": "The creation timestamp.",
      "format": "date-time"
    },
    "type": {
      "readOnly": true,
      "enum": [
        "TYPE_UNSPECIFIED",
        "MEMO_COMMENT",
        "MEMO_MENTION",
        "SPACE_INVITATION"
      ],
      "type": "string",
      "description": "The type of the notification.",
      "format": "enum"
    },
    "memoComment": {
      "readOnly": true,
      "allOf": [
        {
          "$ref": "#/components/schemas/UserNotification_MemoCommentPayload"
        }
      ]
    },
    "memoMention": {
      "readOnly": true,
      "allOf": [
        {
          "$ref": "#/components/schemas/UserNotification_MemoMentionPayload"
        }
      ]
    },
    "spaceInvitation": {
      "readOnly": true,
      "allOf": [
        {
          "$ref": "#/components/schemas/UserNotification_SpaceInvitationPayload"
        }
      ]
    }
  }
}