1. API
  2. v1
  3. CORE
  4. USERS

Notes

Resource Fields

Name Type Read-only Description
body_text string
body_html string
is_pinned boolean Default: false
pinned_by User
user User
attachments Attachments
download_all string Download all attachment as zip
created_at timestamp ISO-8601 Format
updated_at timestamp ISO-8601 Format

Attachments

RESOURCE FIELDS

Name Type Read-only Description
name string
size integer
width integer
Only if the attachment is image
height integer
Only if the attachment is image
type string
Mime-type of the file
content_id string
Content ID used for inline attachment
alt string
url string
The URL to view the attachment
url_download string
The URL to download the attachment
thumbnails Thumbnails
created_at timestamp
ISO-8601 Format

Thumbnails

RESOURCE FIELDS

Name Type Read-only Description
name string
size integer
width integer
height integer
type string
Mime-type of the file
url string
The URL to view the thumbnail
created_at timestamp
ISO-8601 Format



Metadata




 
 



Version 1.0
Last Updated July 04, 2016

Actions

Retrieve all notes

GET /api/v1/users/:id/notes.json

Information

Allowed for Collaborators, Agents, Admins & Owners
Scope users
Ordered by created_at (descending)

Arguments

Name Type Mandatory Description
is_pinned boolean
filter string

This end-point will list the notes which are on user and it's organization.

Response

    {
        "status": 200,
        "data": [
            {
     "id": 1,

     "body_text": "Customer is using Honey - Blend. So communicate accordingly",
     "body_html": null,
     "is_pinned": true,
     "pinned_by": 



{
    "id": 1,

    "resource_type": "user"

}
,
     "user": 



{
    "id": 1,

    "resource_type": "user"

}
,
     "attachments": [],
     "download_all": null,
     "created_at": "2016-02-17T08:20:18+05:00",
     "updated_at": "2016-02-17T08:20:18+05:00",

     "resource_type": "note"

     ,"resource_url": "https://brewfictus.kayako.com/api/v1/users/1/notes/1"

}

        ],
        "resource": "note",
        "offset": 0,
        "limit": 10,
        "total_count": 2
    }

Retreive a note

GET /api/v1/users/:id/notes/:id.json

Information

Allowed for Collaborators, Agents, Admins & Owners
Scope users

Response

    {
        "status": 200,
        "data": {
     "id": 1,

     "body_text": "Customer is using Honey - Blend. So communicate accordingly",
     "body_html": null,
     "is_pinned": true,
     "pinned_by": 



{
    "id": 1,

    "resource_type": "user"

}
,
     "user": 



{
    "id": 1,

    "resource_type": "user"

}
,
     "attachments": [],
     "download_all": null,
     "created_at": "2016-02-17T08:20:18+05:00",
     "updated_at": "2016-02-17T08:20:18+05:00",

     "resource_type": "note"

     ,"resource_url": "https://brewfictus.kayako.com/api/v1/users/1/notes/1"

}
,
        "resource": "note"
    }

Add a note

POST /api/v1/users/:id/notes.json

Information

Allowed for Collaborators, Agents, Admins & Owners
Scope users

Parameters

Name Type Mandatory Description
contents string
is_html boolean If set to true then system will parse the contents through the purify service and render them

Default: false
files[] array multipart/form-data
attachment_file_ids CSV

Response

    {
        "status": 201,
        "data": {
     "id": 1,

     "body_text": "Customer is using Honey - Blend. So communicate accordingly",
     "body_html": null,
     "is_pinned": true,
     "pinned_by": 



{
    "id": 1,

    "resource_type": "user"

}
,
     "user": 



{
    "id": 1,

    "resource_type": "user"

}
,
     "attachments": [],
     "download_all": null,
     "created_at": "2016-02-17T08:20:18+05:00",
     "updated_at": "2016-02-17T08:20:18+05:00",

     "resource_type": "note"

     ,"resource_url": "https://brewfictus.kayako.com/api/v1/users/1/notes/1"

}
,
        "resource": "note"
    }

Update a note

PUT /api/v1/users/:id/notes/:id.json

Information

Allowed for Collaborators, Agents, Admins & Owners
Scope users

Parameters

Name Type Mandatory Description
is_pinned boolean
If set to true then it wil appear as a pinned in the user and conversation timelines.

Response

    {
        "status": 200,
        "data": {
     "id": 1,

     "body_text": "Customer is using Honey - Blend. So communicate accordingly",
     "body_html": null,
     "is_pinned": true,
     "pinned_by": 



{
    "id": 1,

    "resource_type": "user"

}
,
     "user": 



{
    "id": 1,

    "resource_type": "user"

}
,
     "attachments": [],
     "download_all": null,
     "created_at": "2016-02-17T08:20:18+05:00",
     "updated_at": "2016-02-17T08:20:18+05:00",

     "resource_type": "note"

     ,"resource_url": "https://brewfictus.kayako.com/api/v1/users/1/notes/1"

}
,
        "resource": "note"
    }