Sample Note to be added to the incident \",\n \"update_requester\": true\n },\n \"status_change\": null,\n \"priority_change\": null,\n \"category_change\": null,\n \"assignee_change\": null,\n \"tags_change\": null,\n \"requester_change\": null,\n \"requester_group_change\": null,\n \"custom_field_change\": null,\n \"due_date_change\": null,\n \"subject_change\": null,\n \"assets_change\": null,\n \"tasks_change\": null,\n \"impact_change\": null,\n \"team_change\": null,\n \"urgency_change\": null,\n \"resolution_change\": null,\n \"assignment_group_change\": null,\n \"ticket\": {\n \"id\": 58,\n \"display_id\": \"#INC00000058\",\n \"subject\": \"Internet is down\",\n \"resolution\": {\n \"html\": \"Router restarted and configuration updated\",\n \"id\": 69,\n \"edited_agent\": null,\n \"last_edited\": null,\n \"text\": \"Resolved with code fix\\n\\n\",\n \"attachments\": [\n {\n \"id\": 19,\n \"name\": \"Router config.png\"\n }\n ],\n \"kb_articles\": []\n },\n \"description\": {\n \"html\": \"Internet is down. Please check ASAP\",\n \"id\": 68,\n \"edited_agent\": null,\n \"last_edited\": null,\n \"text\": \"Router config updated\",\n \"attachments\": [\n {\n \"id\": 16,\n \"name\": \"Router config.png\"\n },\n {\n \"id\": 17,\n \"name\": \"Router config.png\"\n },\n {\n \"id\": 18,\n \"name\": \"Router config.png\"\n }\n ],\n \"kb_articles\": []\n },\n \"created_by\": {\n \"type\": \"agent\",\n \"id\": 1,\n \"name\": \"Lisa Taylor\"\n },\n \"subscribers\": [\n 3\n ],\n \"assignee\": {\n \"id\": 1,\n \"name\": \"Lisa Taylor\",\n \"email\": \"[email protected]\"\n },\n \"assignment_group\": null,\n \"team\": {\n \"id\": 2,\n \"name\": \"IT Support\"\n },\n \"status\": {\n \"id\": 7,\n \"name\": \"New\",\n \"description\": \"\",\n \"team\": 2\n },\n \"impact\": {\n \"id\": 2,\n \"name\": \"Medium\",\n \"order\": 2,\n \"is_default\": true\n },\n \"urgency\": {\n \"id\": 2,\n \"name\": \"Medium\",\n \"order\": 2,\n \"is_default\": true\n },\n \"priority\": {\n \"id\": 1,\n \"name\": \"Medium\",\n \"description\": \"\",\n \"help_text\": \"\"\n },\n \"requester\": {\n \"id\": 1,\n \"name\": \"Lisa\",\n \"email\": \"[email protected]\",\n \"primary_phone\": null,\n \"created_at\": \"2023-05-08T06:39:00Z\",\n \"updated_at\": \"2023-05-08T06:39:00Z\"\n },\n \"custom_fields\": [\n {\n \"id\": 5,\n \"name\": \"Host\",\n \"type\": \"t\",\n \"value\": null\n },\n {\n \"id\": 6,\n \"name\": \"Severity\",\n \"type\": \"t\",\n \"value\": null\n }\n ],\n \"created_at\": \"2023-05-17T08:50:02Z\",\n \"last_updated_at\": \"2023-06-06T13:30:51Z\",\n \"last_modified_at\": \"2023-06-06T13:30:51Z\"\n }\n }\n\n", "mainEntityOfPage": {"@type": "WebPage", "@id": "https://support.happyfox.com/kb/article/1373-api-to-add-private-note-to-incidents-in-service-desk/"}} Skip to content

API to add private note to Incidents in Service Desk

Views
1676
Last updated
API Endpoint {account_url}/api/v2/public/incidents/{id}/private-note/
Method PATCH
Response Data Private note added 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": "[email protected]",
        "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": "[email protected]"
        },
        "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": "[email protected]",
            "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"
    }
}

 

Tags