-
Notifications
You must be signed in to change notification settings - Fork 561
Create Internal Note
Sayar Samanta edited this page Aug 28, 2018
·
3 revisions
Description : To insert the internal note for a ticket
- 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.
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 |
Did you find it helpful? If not email us on support@faveohelpdesk.com
Installation and Upgrade Guide
- GUI Install Wizard
- Manual Install
- CLI Install
- Server Requirements
- Installation with Apache
- Installation with cPanel
- Cron Job or any Job scheduler
- Faveo Helpdesk Installation on CentOS 7 with Apache on PHP 7.1
- Faveo Helpdesk Installation on CentOS 7 with Nginx on PHP 7.1
- Faveo Helpdesk Installation on Ubuntu 18.04 LTS with Apache on PHP 7.1
- Faveo Helpdesk Installation on Ubuntu 18.04 LTS with Nginx on PHP 7.1
- Faveo Helpdesk Installation on Debian 9 with Nginx on PHP 7.1
- Faveo Helpdesk Installation on Debian 9 with Apache on PHP 7.1
- Migrating Faveo from one server to another
- Configuration of Redis with Faveo
- Install and configure Redis, Supervisor and Worker for Faveo on Ubuntu 16.04
- Install Let’s Encrypt SSL on CentOS 7 Running Apache Web Server
- Install and configure a simple mail server for sending mails using PHP mail function in Faveo on Ubuntu 16.04 server
- Install and configure Redis, Supervisor and Worker for Faveo on Centos 7
- Install and configure a simple mail server for sending mails using PHP mail function in Faveo on Centos 7 server
- Faveo Helpdesk Pro Installation on Windows Server 2012 R2
- Install Active Directory Domain Services in Windows Server 2012 R2
- Install Faveo Helpdesk Community on Centos, Ubuntu or Debian Using Script
- Set up automatic backup for Faveo-Helpdesk
Administrator's Guide
- Faveo File Storage
- Change client side theme color
- How to edit or change the footer in faveo
- How to change agent and admin panel Faveo logo link and logo
- Agents
- Departments
- Team
- Priority
- SLA
- Workflow
- Helptopic
- Default Ticket Settings
- Status
- Rating
- Close Ticket Workflow
- Company Settings
- Social Login
- Language
- Security
- Debugging/Logs
- Ban Emails
- Widgets
Agent's Guide
Email Integration
Release & Upgrade Notes
- General Faveo Upgrade Guide Manual
- General Faveo Upgrade Guide Auto
- Upgrade guide to v1.9.2
- Upgrade guide to v1.9.0
- How to update v1.0.7.9 to v1.0.8.0
- Manual Upgrade from v1.0.7.8 to v1.0.7.9
- Faveo Release notes & upgrade guide for V1.0.7.7
- Faveo Release notes & upgrade guide for V1.0.7.5
- Faveo Release notes & upgrade guide for V1.0.7
Known Issues
- The open_basedir restriction in effect
- 404 Not Found
- 500 Internal Server Error
- Bug after update from 1.0.7.4 to 1.0.7.5 or higher version
- Syntax error, unexpected ‘var’(T_VAR), expecting ‘;’
Contribute & Feedback
- Support the community edition
- Contribution Guide
- Faveo Feedback & Customisation
- Help in language translate
Knowledge Base
Third Party Integration
Plugins
API