Mask activity

Overview

Use this API to mask the content of an activity. User can only mask one activity at a time. Please note that this API can be successful even if masking is not enabled or no masking patterns are configured for the corresponding activity type.

For this API to execute successfully:

  • An activity with the ID specified in the request body must exist.
  • The activity must be of type 'Email' or 'Chat'.
  • The activity must not be locked.
  • If activity is of type 'Chat', it must be in completed state.

As part of completing this API request:

  • For activity of type 'Email', following attributes are masked: subject, content, text content, email header.
  • For activity of type 'Chat', following attributes are masked: subject, chat transcript, survey answers.

Permissions

Actor Permission
User All of the following are required:
  • User must have 'Edit' action on 'Activity' resource or 'Manage Utilities' action on 'Utilities' resource.
  • The activity must either belong to the user's home department, or to a department in which the user is a foreign user.
Client Application No additional permission required.

Licenses

Actor License
User The logged in user must have the following licenses:
  • eGain Advisor Desktop or eGain MailPlus: To mask the content of activity of type 'Email'.
  • eGain Advisor Desktop or eGain ChatPlus: To mask the content of activity of type 'Chat'.
Client Application No additional licenses required.
SecurityoAuthUser or oAuthClient
Request
header Parameters
Accept
required
string
Default: application/json

Content type accepted by client.

Enum: "application/json" "application/xml"
Accept-Language
required
string
Default: en-US

Language locale accepted by client (used for locale specific fields in resource representation and in error responses).

Enum: "en-US" "es-ES" "fr-FR" "it-IT" "de-DE" "nl-NL" "pt-BR" "pt-PT" "da-DK" "ru-RU" "fr-CA" "zh-CN" "ja-JP" "ko-KR" "sv-SE"
Request Body schema: application/json

Elements required in request body

id, lastModified

Array of objects (Activity)
Responses
204

No Content

  • Successfully modified the activity.
400

Bad Request

  • Any criteria for successful execution mentioned in the overview and request body sections are violated.
401

Unauthorized

403

Forbidden

406

Not Acceptable

409

Conflict

500

Internal server error

patch/activity/mask
Request samples
application/json
  • PATCH /core/casemgr/v3/activity/mask
  • This example demonstrates the following:
    • Mask activity.
{
  • "activity": [
    ]
}
Response samples
application/json
{
  • "code": "400-101",
  • "developerMessage": "Unsupported query parameter(s) supplied: '<query_parameter>'."
}