Resolve or reopen a comment thread

Toggle a thread between OPEN and RESOLVED.

PATCH /api/v1/documents/{id}/comments/{threadId}

Resolve or reopen a comment thread

cURL

curl --request PATCH \
  --url https://app.sajn.se/api/v1/documents/{id}/comments/{threadId} \
  --header 'Content-Type: application/json' \
  --header 'authorization: <authorization>' \
  --data '{}'

200

{
  "id": "<string>",
  "documentId": "<string>",
  "excerpt": "<string>",
  "createdAt": "<unknown>",
  "updatedAt": "<unknown>",
  "resolvedAt": "<string>",
  "createdBy": {
    "id": "<string>",
    "name": "<string>",
    "email": "<string>"
  },
  "resolvedBy": {
    "id": "<string>",
    "name": "<string>",
    "email": "<string>"
  },
  "messages": [
    {
      "id": "<string>",
      "threadId": "<string>",
      "parentId": "<string>",
      "body": "<string>",
      "mentions": [
        "<string>"
      ],
      "createdAt": "<string>",
      "editedAt": "<string>",
      "deletedAt": "<string>",
      "author": {
        "id": "<string>",
        "name": "<string>",
        "email": "<string>"
      }
    }
  ]
}

Headers

authorization · string · required

Bearer token for API authentication

Path Parameters

id · string · required

threadId · string · required

Body

application/json

Body

status · enum<string> · required

Mark thread as resolved or reopen it

Available options: OPEN, RESOLVED

Response

200

application/json

200

id · string · required

documentId · string | null · required

status · enum<string> · required

Available options: OPEN, RESOLVED

excerpt · string | null · required

createdAt · any · required

updatedAt · any · required

resolvedAt · string | null · required

createdBy · object · required

Show child attributes

resolvedBy · object · required

Show child attributes

messages · object[] · required

Show child attributes