Delete completed activity attachments

Overview

Use this API to delete attachments of a single completed activity. Only attachments of email or chat activity types can be deleted.

As part of executing this API:

  • All attachments of the activity are deleted.
  • Inline attachments of an email activity are deleted if query parameter 'preserveInlineAttachment' is not provided.

Permission

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

Licenses

Actor Licenses
User The logged in user must have the following licenses
  • eGain Advisor Desktop or eGain MailPlus: To delete attachment of email activities.
  • eGain Advisor Desktop or eGain ChatPlus: To delete attachment of chat activities.
Client Application No additional licenses required.
SecurityoAuthUser or oAuthClient
Request
path Parameters
ids
required
string <= 1500 characters

Pass one id or comma separated list of id(s).

Examples:
Providing single ID.
1001
Providing multiple IDs.
1001,1002
query Parameters
preserveInlineAttachment
string

If provided, only non-inline attachments is deleted.

Value: "yes"
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"
Responses
204

No content

400

Bad Request

  • Request body is not empty.
  • Any criteria for successful execution mentioned in the Overview and Request Body sections are violated.
401

Unauthorized

403

Forbidden

  • If actor is user and it does not have sufficient permissions.
  • If actor is client application and it's type is other than 'API'.
404

Not Found

  • Activity ID supplied in the URI doesn't exist.
406

Not Acceptable

500

Internal server error

delete/activity/{ids}/attachment
Request samples
Response samples
application/json
{
  • "code": "400-203",
  • "developerMessage": "Request body is not allowed."
}