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.
- If the Article has Access Tags:
- 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.
- If the Article has Access Tags:
Authorization
accessToken JWT Bearer Token authentication for API access
In: header
Path Parameters
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.
^[a-zA-Z0-9]{2,4}-\d{4,15}$7 <= length <= 20The ID of the Article.An Article ID is composed of a 2-4 letter prefix followed by a dash and 4-15 digits.
^[a-zA-Z0-9]{2,4}-\d{4,15}$7 <= length <= 20Header Parameters
A unique numeric interaction identifier from eGain.
^[0-9]{4,9}$4 <= length <= 9The 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.
^[\w\W]+$length <= 40A 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.
^[\w\W]+$length <= 40The 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"My Subscription GET
## Overview The My Subscription API allows authenticated users and agents to retrieve the list of articles to which they are subscribed.
Unsubscribe to an Article PUT
## Overview The Unsubscribe to an Article API allows authenticated users and agents to unsubscribe to an Article for which they were earlier subscribed to receive change notifications.

