Detailed Description

Edit Activity

Overview

This API allows user to modify the dueDate, priority, language and the custom attributes of an activity. Only one activity can be modified 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.

Since: 11.6

APIs

Method	URL	Description
PUT	`/ws/v12/interaction/activity`	Modify an existing activity.

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 'Edit Activity' action.
The activity must either belong to the user's home department, or to a department in which the user is a foreign user.

Licenses

The logged in user must have the following licenses:

ECE MailPlus: To modify an email activity.
ECE CallTrackPlus: To modify a calltrack activity.
ECE ChatPlus: To modify a chat activity.

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

The request body is mandatory. Request body can be in either XML or JSON format.

Elements required in the request body

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

Optional elements allowed in the request body

Name	Description
dueDate	If provided, must be a future date. Refer supported date format here.
priority	Must be a value between 1 and 7.
language.value	Language of the activity. This must be one of the supported languages for the activity resource. Refer the Get Activity Attributes API to know the supported languages.
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. For string type of custom attribute that is not configured as an enumeration, refer list of Allowed Characters For Custom Attributes.

NOTE: To remove value of any element of type "String", "integer" or "dateTime", set the value to an empty string (instead of setting the value to null).

Request body XML schemas:

schema-interaction-activity-Activity

Supported API specific query parameters

None

Supported common query parameters

None

Response

Response headers

Name	Description	Possible values
X-egain-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

Successfully modified the activity.

Failure Status codes

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 or Request Body sections are violated.
Request body is empty.

401 - Unauthorized

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

403 - Forbidden

If the user does not have the appropriate permissions for this operation. Refer the Permissions section.

406 - Not Acceptable

Invalid 'Accept-Language' header value.

409 - Conflict

The lastModified date of the activity in the request does not match its lastModified date on the server.

500 - Internal server error

Examples:

Example 1 - Modify all allowed attributes of an activity
Example 2 - Modify activity to remove attribute values