Subscribe for an article

Overview

  • This API allows eGain users, authenticated customers and agents to subscribe for an article to receive the notification about changes in article.
  • Notifications will be sent only if following conditions are met -
    • Article content is modified since last published version.
    • Attachment list is modified since last published version.
    • Author has checked 'Include article in new and modified article list' option while publish article.
  • For this API to execute successfully:
    • Article must be in scope of portal.
    • User must have email address.

Permission

  • Following permissions are required if user is an agent:
    • If article has Access Tags, article must be available for agent's current user profile.
    • If article has Publish Views, at least one edition of article must be available for agent's current user profile.
    • If article has filters and tags query parameter is provided, article filters must match provided tags or tag groups.
  • Following permissions are required if user is a customer:
    • If article has Access Tags:
      • Portal must have default user profile, and;
      • Article must be available for portal's default user profile.
    • If article has Publish Views:
      • Portal must have default user profile, and;
      • At least one edition must be available for portal's default user profile.
    • If article has filters and tags query parameter is provided, article filters must match provided tags or tag groups.
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
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}/subscribe
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>"
}