API to add private note to Incidents in Service Desk
Jan 10, 2024
375
| API Endpoint | {account_url}/api/v2/public/incidents/{id}/private-note/ |
| Method | PATCH |
| Response Data | Private note added to an Incident |
- This endpoint is used to add a private note to an incident.
Sample Request
{
"note": "sample message",
"alert_to": "all_subscribers"
}
Sample Response
Success Response: Status code 200
{
"id": 191,
"time_spent": 0,
"timestamp": "2023-06-06T13:30:51Z",
"by": {
"type": "agent",
"id": 1,
"name": "Lisa",
"email": "lisa.taylors@happyfox.com",
"picture": null,
"picture_small": null
},
"smartrule_email_sent": false,
"smartrule_slack_notification": {},
"smartrule_ms_teams_notification": {},
"smartrule_third_party_app_notification": {},
"smartrule_webhook_triggered": false,
"workflow_info": {},
"smartrule_workflow_info": {},
"canned_actions": [],
"is_cc_update": false,
"is_redirect_update": false,
"message": {
"id": 191,
"cc": [],
"bcc": [],
"forward_recipients": [],
"message_type": "private_note",
"attachments": [],
"other_recipients": [],
"is_call_note": false,
"is_truncated": false,
"text": "X",
"html": "<html><head><meta charset=\"utf-8\"></head><body>Sample Note to be added to the incident</body></html>",
"update_requester": true
},
"status_change": null,
"priority_change": null,
"category_change": null,
"assignee_change": null,
"tags_change": null,
"requester_change": null,
"requester_group_change": null,
"custom_field_change": null,
"due_date_change": null,
"subject_change": null,
"assets_change": null,
"tasks_change": null,
"impact_change": null,
"team_change": null,
"urgency_change": null,
"resolution_change": null,
"assignment_group_change": null,
"ticket": {
"id": 58,
"display_id": "#INC00000058",
"subject": "Internet is down",
"resolution": {
"html": "<html><head><meta charset=\"utf-8\"></head><body>Router restarted and configuration updated</body></html>",
"id": 69,
"edited_agent": null,
"last_edited": null,
"text": "Resolved with code fix\n\n",
"attachments": [
{
"id": 19,
"name": "Router config.png"
}
],
"kb_articles": []
},
"description": {
"html": "<html><head><meta charset=\"utf-8\"></head><body>Internet is down. Please check ASAP</body></html>",
"id": 68,
"edited_agent": null,
"last_edited": null,
"text": "Router config updated",
"attachments": [
{
"id": 16,
"name": "Router config.png"
},
{
"id": 17,
"name": "Router config.png"
},
{
"id": 18,
"name": "Router config.png"
}
],
"kb_articles": []
},
"created_by": {
"type": "agent",
"id": 1,
"name": "Lisa Taylor"
},
"subscribers": [
3
],
"assignee": {
"id": 1,
"name": "Lisa Taylor",
"email": "lisa.taylors@happyfox.com"
},
"assignment_group": null,
"team": {
"id": 2,
"name": "IT Support"
},
"status": {
"id": 7,
"name": "New",
"description": "",
"team": 2
},
"impact": {
"id": 2,
"name": "Medium",
"order": 2,
"is_default": true
},
"urgency": {
"id": 2,
"name": "Medium",
"order": 2,
"is_default": true
},
"priority": {
"id": 1,
"name": "Medium",
"description": "",
"help_text": ""
},
"requester": {
"id": 1,
"name": "Lisa",
"email": "lisa.taylors@happyfox.com",
"primary_phone": null,
"created_at": "2023-05-08T06:39:00Z",
"updated_at": "2023-05-08T06:39:00Z"
},
"custom_fields": [
{
"id": 5,
"name": "Host",
"type": "t",
"value": null
},
{
"id": 6,
"name": "Severity",
"type": "t",
"value": null
}
],
"created_at": "2023-05-17T08:50:02Z",
"last_updated_at": "2023-06-06T13:30:51Z",
"last_modified_at": "2023-06-06T13:30:51Z"
}
}
