Supported Formats

json

Examples

POST /api/v1/notes
note%5Bteam%5D=test&note%5Btitle%5D=Test+note
200
{
  "id": 438,
  "user_id": 3,
  "is_private": true,
  "title": "Test note",
  "created_at": "2016-01-07T02:08:51.622Z",
  "updated_at": "2016-01-07T02:08:51.622Z",
  "format": "html",
  "share": "none",
  "is_time_track": true,
  "name": "438",
  "team": {
    "id": 383,
    "name": "test",
    "is_default": true,
    "created_at": "2016-01-07T02:08:41.000Z",
    "updated_at": "2016-01-07T02:08:52.177Z",
    "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:08:41.000Z",
        "updated_at": "2016-01-07T02:08:50.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/438",
  "avatar_url": "http://www.example.com/test/438/avatar",
  "can_pull": false,
  "can_request": false,
  "can_manage": true,
  "description_html": "<p></p>",
  "model": "note"
}

Params

Param name Description
note
optional

Value:

Must be a Hash

note[title]
required

Value:

Must be String

note[description]
optional

Value:

Must be String

note[team]
required

Team name


Value:

Must be String

note[slug]
optional

Value:

Must be String

note[is_private]
optional

Value:

Must be one of: true, false.