Skip to content
Knowledge APIs
/
/
/
Subscribe to an Article

Subscribe to an Article

Request

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.
Security
oAuthUser(Required scopes:
https://api.egain.cloud/auth/kno...
) or oAuthOnBehalfOfUser(Required scopes:
https://api.egain.cloud/auth/kno...
) or oAuthCustomer(Required scopes:
https://api.egain.cloud/auth/kno...
) or oAuthOnBehalfOfCustomer(Required scopes:
https://api.egain.cloud/auth/kno...
)
Path
portalIDstring, [ 7 .. 20 ] characters^[a-zA-Z0-9]{2,4}-\d{4,15}$required

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
articleIDstring, [ 7 .. 20 ] characters^[a-zA-Z0-9]{2,4}-\d{4,15}$required

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
Headers
x-egain-activity-idstring, [ 4 .. 9 ] characters^[0-9]{4,9}$

A unique numeric interaction identifier from eGain.

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

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

Note: The x-ext-integration-id and x-ext-interaction-id headers must always be provided together and cannot be supplied independently.

The x-egain-activity-id may be provided on its own, or it may be provided along with both x-ext-integration-id and x-ext-interaction-id.

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

A unique interaction identifier from other CRM applications.

Note: The x-ext-integration-id and x-ext-interaction-id headers must always be provided together and cannot be supplied independently.

The x-egain-activity-id may be provided on its own, or it may be provided along with both x-ext-integration-id and x-ext-interaction-id.

Examples:
uuid
3155180e-0c13-43e9-9c38-e9045bcbf176
hex
00Dbn00000IxGnx
Accept-Languagestringrequired

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"
Example:en-US
PUT
/portals/{portalID}/articles/{articleID}/subscribe
curl -i -X PUT \
  https://api.egain.cloud/knowledge/portalmgr/v4/portals/PROD-1000/articles/PROD-2996/subscribe \
  -H 'Accept-Language: en-US' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'x-egain-activity-id: 59237' \
  -H 'x-ext-integration-id: 3155180e-0c13-43e9-9c38-e9045bcbf176' \
  -H 'x-ext-interaction-id: 3155180e-0c13-43e9-9c38-e9045bcbf176'

Responses

No Content

Response
No content