Supported Formats

json

Examples

POST /api/v1/test/test_note/12/comments
comment%5Bcomment%5D=Test+comment&mentions%5B%5D=test1
200
{
  "id": 1,
  "comment": "Test comment",
  "user_id": 3,
  "created_at": "2016-01-07T02:02:02.381Z",
  "updated_at": "2016-01-07T02:02:02.381Z",
  "user": {
    "id": 3,
    "username": "test",
    "receive_email": true,
    "created_at": "2016-01-07T02:01:50.000Z",
    "updated_at": "2016-01-07T02:02:00.000Z",
    "keyboard_shortcuts": false,
    "options": {
      "advanced_menu": true
    },
    "html_url": "http://www.example.com/test",
    "avatar_url": "http://www.example.com/test/avatar",
    "lang": {
      "code": "en",
      "model": "lang"
    },
    "name": "test",
    "model": "user"
  },
  "mentions": [
    {
      "id": 1,
      "username": "test1",
      "receive_email": true,
      "created_at": "2016-01-07T02:01:50.000Z",
      "updated_at": "2016-01-07T02:02:02.000Z",
      "keyboard_shortcuts": false,
      "html_url": "http://www.example.com/test1",
      "avatar_url": "http://www.example.com/test1/avatar",
      "lang": {
        "code": "ja",
        "model": "lang"
      },
      "name": "test1",
      "model": "user"
    }
  ],
  "can_delete": true,
  "type": "page",
  "page": {
    "id": 12,
    "title": "Test page",
    "created_at": "2016-01-07T02:01:57.000Z",
    "updated_at": "2016-01-07T02:02:02.395Z",
    "is_cover": false,
    "note": {
      "id": 7,
      "is_private": false,
      "slug": "test_note",
      "title": "Test note",
      "created_at": "2016-01-07T02:01:56.000Z",
      "updated_at": "2016-01-07T02:02:02.396Z",
      "format": "html",
      "share": "none",
      "is_time_track": true,
      "name": "test_note",
      "team": {
        "id": 3,
        "name": "test",
        "is_default": true,
        "created_at": "2016-01-07T02:01:50.000Z",
        "updated_at": "2016-01-07T02:02:02.396Z",
        "html_url": "http://www.example.com/test",
        "avatar_url": "http://www.example.com/test/avatar",
        "role": "manager",
        "managers": [
          {
            "id": 3,
            "username": "test",
            "receive_email": true,
            "created_at": "2016-01-07T02:01:50.000Z",
            "updated_at": "2016-01-07T02:02:00.000Z",
            "keyboard_shortcuts": false,
            "options": {
              "advanced_menu": true
            },
            "html_url": "http://www.example.com/test",
            "avatar_url": "http://www.example.com/test/avatar",
            "lang": {
              "code": "en",
              "model": "lang"
            },
            "name": "test",
            "model": "user"
          }
        ],
        "members": [],
        "plan": "micro",
        "model": "team"
      },
      "html_url": "http://www.example.com/test/test_note",
      "avatar_url": "http://www.example.com/test/test_note/avatar",
      "can_pull": false,
      "can_request": false,
      "can_manage": true,
      "description_html": "<p></p>",
      "model": "note"
    },
    "html_url": "http://www.example.com/test/test_note/12",
    "content": "Test content",
    "path": "Test page",
    "children": [],
    "model": "page"
  },
  "model": "comment"
}

Params

Param name Description
comment
optional

Value:

Must be a Hash

comment[comment]
required

Value:

Must be String

mentions
optional

Usernames


Value:

Must be an array of String