iService API Documentation

Zoom Window Out
Larger Text | Smaller Text
Hide Page Header
Show Expanding Text
Printable Version
Send Mail Feedback
Share This Topic
Save Permalink URL

Navigation: iService API Forms > Customer Info

Creating a note (api=createnote)

Purpose

The createnote API is used to create a Public or Private Note. Within the iService user interface, the note forms use the startnote endpoint to fetch the details needed to load the form. The createnote endpoint is then used to create the public or private note interaction.

UI Reference: The API is called when the create public or private note buttons are pressed.

URI: webapp-api-custinfo?api=createnote

Access Rights Required: All agents

Request

Request Parameters

Name	Type	Description
details	Object	This parameter represents creating email form fields values object.
details[].inResponseToID	String	If the ticket is part of a case, the case ID (interaction root) is specified.
details[].subject	String	The subject line for the note.
details[].segmentID	String	The segment ID for the note.
details[].topicID	String	The topic ID for the note.
details[].addSubjectRefNum	boolean	Indicates whether a reference number will be added to the subject line.
details[].ContactID	Number	The ID of the contact for whom the note is created by the agent.
details[].bodyHtml	String	The HTML body for the ticket.
details[].action	Number	Not used
details[].properties	Array	Properties associated with the topic are submitted in a special format. See properties that may be edited.
details[].caseproperties	Array	Properties associated with the topic are submitted in a special format. See properties that may be edited.

Request Payload Example

{
    "details": {
        "inResponseToID": "",
        "subject": "This is a testing Note",
        "segmentID": "2",
        "topicID": "2",
        "addSubjectRefNum": true,
        "contactID": 466,
        "bodyHtml": "This is a testing Note",
        "action": 4,
        "properties": [],
        "caseProperties": []
    }
}

Response

Response Parameters

Name	Type	Description
errors	Array	Errors returned for the submission.
interactionID	String	The interaction ID of the note created.
row	Array	An array of strings that describes the note created.
row[].id	String	Id of the interaction created.
row[].subject	String	Subject of the interaction created.
row[].type	String	Type of the interaction created. In this case it is Private Note.
row[].date	String	Date of the interaction created.

Response Example

{
    "errors": [],
    "interactionID": "45403",
    "row": {
        "id": "45403",
        "subject": "[ref#: 45403-45403] This is a testing Note",
        "type": "Private Note",
        "date": "2021-10-18T09:25:28.8100000Z"
    }
}

Please enable JavaScript to view this site.