Edit completed activity

Overview

Use this API to modify the content and custom attributes of a completed activity. Only one activity can be modified at a time.

For this API to execute successfully:

  • An activity with the ID specified in the request body must exist.
  • The status of the specified activity must be 'completed'.
  • It must be an email activity or a chat activity.

Permissions

Actor Permission
User All of the following are required
  • Must have 'Manage completed activity' action on the 'Activity' resource.
  • The activity must either belong to the logged in 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 edit email activities.
  • eGain Advisor Desktop or eGain ChatPlus: To edit chat activities.
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

The request body is mandatory.

Elements required in request body

Name Description
id ID of the activity.
lastModified Value of last modified date of the activity .
payload.chat.transcript.content or
payload.email.content or
customAttributes
  • payload.chat.transcript.content specifies content of chat activity. The content must be "html".
  • payload.email.content specifies content of email activity. Supported content types are "text" and "html". One or both can be provided. The provided content must not have new inline attachment.
  • customAttributes specifies name of the custom attributes configured in application. If the custom attribute is configured as an enumeration, the value must be one of the predefined values.
NOTE: To remove value of any element, set the value to an empty string (instead of setting the value to null).
object (link)
Array of objects (activity) >= 0 items
object (paginationInfo)
count
integer (count)
Responses
204

No Content

  • Successfully modified the activity.
400

Bad Request

  • Any query parameter is sent in the request.
  • Request body does not contain the required elements.
  • Unsupported element is present in the request body.
  • Any criteria for successful execution mentioned in the Overview and Request Body sections are violated.
  • Request body is empty.
401

Unauthorized

403

Forbidden

406

Not Acceptable

409

Conflict

500

Internal server error

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