Add or update a comment

Adds a new comment to a card. To update an existing comment, include its id in the body — the userId must match the original comment’s author.

POST /api/board/{boardId}/{cardId}/comment

Add or update a comment

cURL

curl --request POST \
  --url https://core-api.getaptly.com/api/board/{boardId}/{cardId}/comment \
  --header 'Content-Type: application/json' \
  --header 'x-token: <api-key>' \
  --data '
{
  "userId": "<string>",
  "content": "<string>",
  "id": "<string>"
}
'

200

{
  "data": {
    "id": "<string>",
    "userId": "<string>",
    "content": "<string>",
    "createdAt": "2023-11-07T05:31:56Z"
  }
}

Authorizations

x-token · string · header · required

Path Parameters

boardId · string · required

cardId · string · required

Body

application/json

userId · string · required

Aptly user ID of the comment author.

content · string · required

Comment text.

id · string

Existing comment ID — include to update rather than create.

Response

200

application/json

Comment created or updated.

data · object

Show child attributes