Unsubscribe an article

Overview

  • This API allows authenticated customers and agents to unsubscribe for an article which is earlier subscribed to receive the notification about the any changes made in article.
SecurityoAuthUser or oAuthCustomer
Request
path Parameters
portalID
required
number
Example: 202200000001001
articleID
required
string

The Id of the article on which operation is performed. Both numeric and alternate Id formats are supported for article Id.

Examples:
Providing readable article id.
PROD-2268
Providing numeric article id.
202200000002268
query Parameters
unsubscriptionToken
string

Encrypted token has information of object/userId/userType/userProfileId. This is used to unsubscribe article from email notification without login to application.

header Parameters
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"
X-egain-tenant-id
string

Unique identifier for tenant.

X-egain-activity-id
integer

Numeric unique identifier of interaction from eGain.

X-interaction-id
string

Unique identifier for interaction from other CRM applications.

Responses
204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

406

Not acceptable

500

Internal server error

put/portals/{portalID}/articles/{articleID}/unsubscribe
Request samples
Response samples
application/json
Required query parameter is missing


{
  • "code": "400-112",
  • "developerMessage": "Required query parameter(s) is missing. The following parameters are required: <param name>"
}