Detailed Description

Delete case notes

Overview

This API allows user to delete notes of a case. A maximum of 75 notes can be deleted at a time.

Since: 12.0 ES1

APIs

Method	URL	Description
DELETE	`/ws/v12/interaction/case/{ID}/note/{IDs}`	Deletes note of a case. {ID}: ID of the case. {IDs}: Comma separated list of note IDs.

Authentication

Authentication is required. The client must be logged in to call this API. Each API request must contain X-egain-session request header returned by Login API.

Permissions

All of the following are required:

User must have 'Delete' action on the 'Notes' resource.
The case must belong to either the user's home department, or to the department in which the user is a foreign user.

Licenses

The logged in user must have the following licenses:

Any User Licenses

Request

Request headers

Name	Description	Allowed values	Default value
X-egain-session	Session ID obtained from Login API response header	N/A	N/A
Accept	Content type accepted by client.	`application/xml` or `application/json`	N/A
Content-Type	Media type sent by the client	`application/xml` or `application/json`	N/A
Accept-Language	Language locale accepted by client (used for locale specific fields in resource representation and in error responses)	Supported 'Accept-Language' header codes	`default system language`

Request Body

Request body is not supported and hence, it must not be provided.

Supported API specific query parameters

None

Supported common query parameters

None

Response

Response headers

Name	Description	Possible values
X-egain-session	Session ID of the current user session	N/A
Content-Type	Media type of response body	`application/xml` or `application/json`

Response body XML schemas:

schema-kb-WSError - used in case of error

HTTP status codes

Success Status codes

204 - No Content

The request was successfully executed.

Failure Status codes

400 - Bad Request

Request body is not empty.
Any query parameter is provided.
One or more note IDs provided in the request do not belong to the case.

401 - Unauthorized

X-egain-session request header is missing.
Session is invalid or expired.

403 - Forbidden

The user does not have sufficient permissions. Refer Permissions section for details.

404 - Not Found

Case ID provided in the request is not found.
One or more note IDs provided in the request were not found.

406 - Not Acceptable

Invalid 'Accept-Language' header value

500 - Internal server error

Examples:

Example 1 - Delete a single case note
Example 2 - Delete multiple notes of a case