Headers

Header name Description
Content-Type
required
application/json
X-API-KEY
required
YOUR_API_KEY

Params

Param name Description
comment
required

Comment content

Validations:

  • Must be a String

Examples

// Successful request
POST /api/v2/projects/-Ghq8n5DKp87bH0Eok0b/comments
{
  "comment": "new comment"
}
200
{
  "comment": {
    "id": 12,
    "message": "new comment",
    "updated_at": "2023-11-27T09:43:11.769Z",
    "user": {
      "id": 180,
      "email": "admin-user-157@example.com",
      "first_name": null,
      "last_name": null,
      "avatar_url": null
    },
    "mentioned_users": []
  }
}
// If :project_id is not found
POST /api/v2/projects/not-found-id/comments
{
  "comment": "new comment"
}
404
{
  "error": "project not found"
}

Errors

Code Description
401 Unauthorized
404 Not found
500 Internal Server Error
422 Missing parameters