PUT
Update Case (add note)
Add a new note into an existing Case.
Important
Calls to this method must include the cookie .LawPanel.AuthCookie in order to identify you at user level. For more details about authentication please check this link. To obtain the cookie you can use the method Login.
Request URL
Request parameters
string
Case ID where the note will be added.
Request headers
string
Subscription key which provides access to this API.
Request body
By example, to add a note and send a communication through email system, you could send a model similar to this:
- string Requerid note: Contents of the note. May contains HTML tags.
- bool Requerid send_communication: If true, a notification will be sent to the client, it will be a "Public Note", otherwise it is a "Private Note" and will not be sent.
- string Optional communication_channel_id: The communication channel ID to notify client about the note added. If you leave this field empty or null, the note will be added and the client not will be notified. To get details of communication channel please check this link.
Loading...
{
"type": "object",
"properties": {
"note": {
"type": "string"
},
"send_communication": {
"type": "string"
},
"communication_channel_id": {
"type": "string"
}
},
"example": {
"note": "<h1>Hello!</h1><p>I am a note into the File.</p>",
"send_communication": "false",
"communication_channel_id": "ICommunicationChannelEmail"
}
}
Response 200
Return 200 when the note added successfully.
Loading...
Response 400
A 400 error is returned if you have some invalid data into your payload, i.e.: biggest text fields, invalid IDs, etc.
Loading...