Article

Subscribe to an Article

PUT
/knowledge/portalmgr/v4/portals/{portalID}/articles/{articleID}/subscribe

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.

Authorization

accessToken
AuthorizationBearer <token>

JWT Bearer Token authentication for API access

In: header

Path Parameters

portalID*string

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.

Match^[a-zA-Z0-9]{2,4}-\d{4,15}$
Length7 <= length <= 20
articleID*string

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

Match^[a-zA-Z0-9]{2,4}-\d{4,15}$
Length7 <= length <= 20

Header Parameters

x-egain-activity-id?string

A unique numeric interaction identifier from eGain.

Match^[0-9]{4,9}$
Length4 <= length <= 9
x-ext-integration-id?string

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.

Match^[\w\W]+$
Lengthlength <= 40
x-ext-interaction-id?string

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.

Match^[\w\W]+$
Lengthlength <= 40
Accept-Language*string

The Language locale accepted by the client (used for locale specific fields in resource representation and in error responses).

Value in

  • "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"

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PUT "https://example.com/knowledge/portalmgr/v4/portals/PROD-1000/articles/PROD-2996/subscribe" \  -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" \  -H "Accept-Language: en-US"
Empty