Skip to content

Create Internal Note

Sayar Samanta edited this page Aug 28, 2018 · 3 revisions

Description : To insert the internal note for a ticket

  1. URL : api/v1/helpdesk/internal-note

Parameters :

Name Data Type Required/Optional Description
token String Required token generated for a user
api_key String Optional An alphanumeric code that can be used to authenticate your API calls
ticketid String Required id of the ticket want to insert internal note
userid String Required user id of the inserted user
body String Required content of the internal note

HTTP Method : POST

Response Format : JSON

Response : Returns success response after posting the internal note.In case of any errors, an error message will be returned.

URL Request Example : http://www.stablehelpdeskc.faveodemo.com/api/v1/helpdesk/internal-note?api_key=9p41T2XFZ34YRZJUNQAdmM7iV0Rr1CjN&ip=null&token=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwOlwvXC9wcm9kdWN0ZGVtb3VybC5jb21cL2NvbW11bml0eVwvcHVibGljXC9hcGlcL3YxXC9hdXRoZW50aWNhdGUiLCJpYXQiOjE1MzUwMTQyMzEsImV4cCI6MTUzNTAxNDQ3MSwibmJmIjoxNTM1MDE0MjMxLCJqdGkiOiJRN0NJeVFBQzh5Y1BrSGNjIiwic3ViIjoxLCJwcnYiOiI4N2UwYWYxZWY5ZmQxNTgxMmZkZWM5NzE1M2ExNGUwYjA0NzU0NmFhIn0.kwH5-HznXnUh4U6atu2ewZYIWCSmYQz1QT-UvPy-YjI&ticket_id=114&user_id=1&body=test+Internal+Note

JSON Response Example :

Success Response :

{
    "thread": {
        "ticket_id": "114",
        "user_id": "1",
        "is_internal": 1,
        "body": "test Internal Note",
        "updated_at": "2018-08-23 08:54:06",
        "created_at": "2018-08-23 08:54:06",
        "id": 273
    }
}

Some Common Error :

Error Response : If the token is expired

{
“error":"Token has expired"
}

If the token is not provided

 {
  "error": "token_not_provided"
}

If the user id is not provided

{
    "error": {
        "user_id": [
            "The user id field is required."
        ]
    }
}

If the ticket id is not provided

{
    "error": {
        "ticket_id": [
            "The ticket id field is required."
        ]
    }
}

If the body is not provided

{
    "error": {
        "body": [
            "The body field is required."
        ]
    }
}

Response Description :

Parameter Description
ticket_id id of the ticket
user_id id of the user
is_internal indicates is it a internal note or not
body body of the internal note
updated_at internal note updated time
created_at internal note created time
id id of the therad

Installation and Upgrade Guide

Administrator's Guide

Agent's Guide

Email Integration

Release & Upgrade Notes

Known Issues

Contribute & Feedback

Knowledge Base

Third Party Integration

Plugins

API

Clone this wiki locally