Sign in
Notifications

Update notification

Updates a notification. Users can only update their own notifications.

patch/notifications/{id}

Request

  • Base URL: /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/notifications/{id}
  • Auth: one of:
    • HTTP bearer
    • API key in header X-Api-Key

Path parameters

idstring required
Example:1357158568008091264

ID of the notification to update

Request body

isReadboolean

Whether the notification has been read

Example request

{
  "isRead": true
}

Response

Notification updated successfully

Example response

{
  "item": {
    "id": "1357158568008091264",
    "userId": "1357158568008091265",
    "creatorUserId": "1357158568008091266",
    "boardId": "1357158568008091267",
    "cardId": "1357158568008091268",
    "commentId": "1357158568008091269",
    "actionId": "1357158568008091270",
    "type": "commentCard",
    "data": {
      "card": {
        "name": "Implement user authentication"
      },
      "text": "This task is almost complete..."
    },
    "createdAt": "2024-01-01T00:00:00.000Z",
    "updatedAt": "2024-01-01T00:00:00.000Z"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.