Edit activity

Overview

Use this API to modify the dueDate, priority, language and the custom attributes of an activity. User can modify only one activity at a time. This API is applicable for all activity types.

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 'assigned'.
  • Activity must be assigned to the logged in user.
  • At least one of the attributes apart from mandatory attributes must be provided.

Permissions

Actor Permission
User All of the following are required:
  • Must have 'Edit Activity' action.
  • 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 modify an email or social activity.
  • eGain Advisor Desktop or eGain CallTrackPlus: To modify a calltrack activity.
  • eGain Advisor Desktop or eGain ChatPlus: To modify a chat activity.
  • Any User License: To modify a task or generic activity. Refer Licenses section for more information.
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. Request body can be in either XML or JSON format.

Elements required in request body

Name Description
id ID of the activity.
lastModified Value of last modified date of the activity .

Optional elements allowed in the request body

Name Description
dueDate Due date for the activity. If provided, must be a future date.
priority Activity priority.
language.value Language of the activity. This must be one of the supported languages for the activity resource.
customAttributes Name must match one 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.
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
Request samples
application/json
  • PATCH /core/casemgr/v3/activity
  • This example demonstrates the following:
    • Editing all allowed attributes of an activity.
{
  • "activity": [
    ]
}
Response samples
application/json
{
  • "code": "400-101",
  • "developerMessage": "Unsupported query parameter(s) supplied: '<query_parameter>'."
}