Mark card notifications as read

Marks all notifications for a specific card as read for the current user. Requires access to the card.

post/cards/{id}/read-notifications

Request

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

Path parameters

idstring required

Example:1357158568008091264

ID of the card to mark notifications as read for

Response

Notifications marked as read successfully

Example response

{
  "item": {
    "id": "1357158568008091264",
    "boardId": "1357158568008091265",
    "listId": "1357158568008091266",
    "creatorUserId": "1357158568008091267",
    "prevListId": "1357158568008091268",
    "coverAttachmentId": "1357158568008091269",
    "type": "project",
    "position": 65536,
    "name": "Implement user authentication",
    "description": "Add JWT-based authentication system...",
    "dueDate": "2024-01-01T00:00:00.000Z",
    "stopwatch": {
      "startedAt": "2024-01-01T00:00:00.000Z",
      "total": 3600
    },
    "commentsTotal": 100,
    "listChangedAt": "2024-01-01T00:00:00.000Z",
    "createdAt": "2024-01-01T00:00:00.000Z",
    "updatedAt": "2024-01-01T00:00:00.000Z"
  },
  "included": {
    "notifications": [
      {
        "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.