Case Notes (Deprecated)
The deprecation date is set for 2019/09/01.
Get all case notes (deprecated)
GET /cases/:case_id/notes
Response
Status code 200
{
"data": [
{
"id": 201,
"note": "This is a note!",
"user": {
"id": 1,
"first_name": "Jane",
"last_name": "Doe",
"phone_number": "+4588888888",
"job_title": "Sales Executive",
"email": "demo@easir.com",
"email_notifications": false,
"profile_picture": "https://randomuser.me/api/portraits/thumb/women/5.jpg",
"system_user": false,
"created_at": "2014-01-01 12:45:56",
"updated_at": "2017-05-26 21:19:41"
},
"created_at": "2017-05-26 21:20:02",
"updated_at": "2017-05-26 21:20:02"
},
{
"id": 202,
"note": "This is the second note.",
"user": {
"id": 1,
"first_name": "Jane",
"last_name": "Doe",
"phone_number": "+4588888888",
"job_title": "Sales Executive",
"email": "demo@easir.com",
"email_notifications": false,
"profile_picture": "https://randomuser.me/api/portraits/thumb/women/5.jpg",
"system_user": false,
"created_at": "2014-01-01 12:45:56",
"updated_at": "2017-05-26 21:19:41"
},
"created_at": "2017-05-26 21:20:52",
"updated_at": "2017-05-26 21:21:06"
}
],
"pagination": {
"total": 2,
"page": 1,
"per_page": 15,
"urls": {
"previous": null,
"next": null
}
}
}
Create a case note (deprecated)
POST /cases/:case_id/notes
Parameters
note
string - Your note.- Required
notify.users
array - User ids to notify.notify.teams
array - Team ids to notify.
Payload
{
"note" : "Some note",
"notify": {
"users": [1, 2, 3],
"teams": [1]
}
}
Response
Status code 201
{
"id": 203,
"note": {
"id": 205,
"note": "Here is some note",
"user": {
"id": 1,
"first_name": "Doe",
"last_name": "John",
"phone_number": "+4588888888",
"job_title": "Animal",
"email": "info@easir.com",
"profile_picture": "http://api.randomuser.me/portraits/thumb/women/5.jpg",
"created_at": "2014-01-01 12:45:56",
"updated_at": "2015-04-09 05:07:36"
},
"created_at": "2015-04-09 05:17:57",
"updated_at": "2015-04-09 05:17:57"
},
"user": {
"id": 1,
"first_name": "Doe",
"last_name": "John",
"phone_number": "+4588888888",
"job_title": "Animal",
"email": "info@easir.com",
"profile_picture": "http://cdn.cutestpaw.com/wp-content/uploads/2013/06/l-Baby.jpeg",
"created_at": "2014-01-01 12:45:56",
"updated_at": "2014-01-02 00:11:22"
},
"created_at": "2015-02-02 07:59:29",
"updated_at": "2015-02-02 07:59:29"
}
Update a case note (deprecated)
PUT /cases/:case_id/notes/:note_id
Parameters
note
string - Your note.- Required
notify.users
array - User ids to notify.notify.teams
array - Team ids to notify.
Payload
{
"note" : "Some updated note",
"notify": {
"users": [1, 2, 3],
"teams": [1]
}
}
Response
Status code 200
{
"id": 203,
"note": {
"id": 205,
"note": "Here is some note",
"user": {
"id": 1,
"first_name": "Doe",
"last_name": "Another",
"phone_number": "+4588888888",
"job_title": "Animal",
"email": "info@easir.com",
"profile_picture": "http://api.randomuser.me/portraits/thumb/women/5.jpg",
"created_at": "2014-01-01 12:45:56",
"updated_at": "2015-04-09 05:07:36"
},
"created_at": "2015-04-09 05:17:57",
"updated_at": "2015-04-09 05:17:57"
},
"user": {
"id": 1,
"first_name": "Doe",
"last_name": "John",
"phone_number": "+4588888888",
"job_title": "Animal",
"email": "info@easir.com",
"profile_picture": "http://cdn.cutestpaw.com/wp-content/uploads/2013/06/l-Baby.jpeg",
"created_at": "2014-01-01 12:45:56",
"updated_at": "2014-01-02 00:11:22"
},
"created_at": "2015-02-02 07:59:29",
"updated_at": "2015-02-02 08:02:31"
}
Delete a case note (deprecated)
DELETE /cases/:case_id/notes/:note_id
Response
Status code 204