Subscribe to an Article

Overview

The Subscribe to an Article API allows eGain users, authenticated customers and agents to subscribe and receive notifications about changes to an Article.

Prerequisites

  • Notifications are sent only if the following conditions are met:
    • The Article content has been modified since the last published version.
    • The attachment list has been modified since the last published version.
    • The author has checked the "Include Article in new and modified Article list" option while publishing the Article.
  • For the Subscribe to an Article API to execute successfully:
    • The Article must be in the portal.
    • The user must have provided an email address.

Permissions

  • Agent Permissions: The following permissions are required if the user is an agent:
    • If the Article has Access Tags:
      • The Article must be available for the agent's current user profile.
    • If the Article has Publish Views:
      • At least one edition of the Article must be available for the agent's current user profile.
    • If the Article has filters and the "tags query parameter" is provided:
      • The Article filters must match the provided tags or tag groups.
  • Customer Permissions: The following permissions are required if the user is a customer:
    • If the Article has Access Tags:
      • The portal must have a default user profile
      • The Article must be available for the portal's default user profile.
    • If the Article has Publish Views:
      • The portal must have a default user profile
      • At least one edition must be available for the portal's default user profile.
    • If the Article has filters and the "tags query parameter" is provided, then the Article filters must match the provided tags or tag groups.
SecurityoAuthUser or oAuthCustomer
Request
path Parameters
portalID
required
string [ 7 .. 20 ] characters ^[a-zA-Z0-9]{2,4}-\d{4,15}$

The ID of the portal being accessed.

A portal ID is composed of a 2-4 letter prefix, followed by a dash and 4-15 digits.

Example: PROD-1000
articleID
required
string [ 7 .. 20 ] characters ^[a-zA-Z0-9]{2,4}-\d{4,15}$

The ID of the Article.

An Article ID is composed of a 2-4 letter prefix followed by a dash and 4-15 digits.

Example: PROD-2996
header Parameters
x-egain-activity-id
string [ 4 .. 9 ] characters ^[0-9]{4,9}$

A unique numeric interaction identifier from eGain.

Example: 59237
x-ext-integration-id
string <= 40 characters ^[\w\W]+$

The unique numeric identifier for a tenant, used in self-service functionality as well as third-party integrations.

Note: If x-egain-activity-id is not provided, then this must be passed along with x-ext-interaction-id.

Examples:
3155180e-0c13-43e9-9c38-e9045bcbf176
00Dbn00000IxGnx
x-ext-interaction-id
string <= 40 characters ^[\w\W]+$

A unique interaction identifier from other CRM applications.

Note: If x-egain-activity-id is not provided, then this must be passed along with x-ext-integration-id.

Examples:
3155180e-0c13-43e9-9c38-e9045bcbf176
00Dbn00000IxGnx
Accept-Language
required
string

The Language locale accepted by the 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"
Example: en-US
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>"
}