PUT/projects/api/v3/comments/markread.json

Mark multiple comments as read

Marks comments as read for the authenticated user, and marks any notifications raised by those comments as read too. Provide exactly one of commentIds, objectType with objectId, or all.

Body Params

MarkReadRequest contains the comments to be marked as read.

    • Name
      all
      Type
      boolean
      Description
      All marks every unread comment the user can see as read.
    • Name
      commentIds
      Type
      array
      Description
      CommentIDs are the specific comments to mark as read.
    • Name
      objectId
      Type
      integer
      Description
      ObjectID is the object to mark every unread comment on. Requires objectType.
    • Name
      objectType
      Type
      string
      Description
      ObjectType is the type of object to mark every unread comment on. One of task, file, fileversion, notebook, milestone, link, event, status, projectupdate or customitemrecord. Requires objectId.

    Responses

    • Code
      204
      Description
      204 No Content No Data
    • Code
      400
      Type
      object
      Schema
      Description
      400 Bad Request
      ErrorResponse defines how []Error should be marshaled to JSON.
    • Code
      403
      Type
      object
      Schema
      Description
      403 Forbidden
      ErrorResponse defines how []Error should be marshaled to JSON.
    • Code
      404
      Description
      404 Not Found No Data

    Examples

    400 Bad Request

    ErrorResponse
    {
      "errors": [
        {
          "code": "string",
          "detail": "string",
          "id": "string",
          "meta": {},
          "title": "string"
        }
      ]
    }