Description:

To post an internal note for a ticket in Faveo.

URL :   api/v1/helpdesk/internal-note   

            (Replace this URL with you helpdesk URL)

Parameters:

Name Data Type Required / Optional Description
api_key String Optional An alphanumeric code that can be used to authenticate your API calls
ip String Optional IP address of the Customer/location where API call is being made from
token String Required Token generated for a user
ticket_id Integer Required id of the ticket want to insert the internal note
user_id Integer Required The user id of the inserted user
body Integer Required The content of the internal note

HTTP Method : POST         

  •   URL Request Example:

https://www.stablehelpdesk.faveodemo.com/api/v1/helpdesk/internal-note?token=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOjEsImlzcyI6Imh0dHA6Ly9wcm9kdWN0ZGVtb3VybC5jb20vc2FyZnJhei9wdWJsaWMvYXBpL3YxL2F1dGhlbnRpY2F0ZSIsImlhdCI6MTUzNDc0NzMzMSwiZXhwIjoxNTM0NzQ3NTcxLCJuYmYiOjE1MzQ3NDczMzEsImp0aSI6IlBlQWdFSEt6Y3Rpc0h3dXkifQ.5CTfqjh26q1s9iYuIC5G4_fwIGPP&ticket_id=8&body=This is the sample body for the ticket.&user_id=13

 

Response

  •   Response Format: JSON
  •   Returns JSON which contains below response

Sample JSON Success Response :

               {

                     "success": true,

                     "message": "Posted note successfully"

                 }

Response Description:

Parameter                                              Description
success It will give a boolean value like true or false. If posted note successfully then it will give true value else it will give a false value.
message It will give a message which contains posted successfully.

Possible Errors/Failures:

   *Please check the responses for some common errors

Leave a Reply

Your email address will not be published. Required fields are marked *