My Subscription
Overview
The My Subscription API allows authenticated users and agents to retrieve the list of articles to which they are subscribed.
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 <= 20Query Parameters
For agents with the View Author Portal or View Staging Portal actions, this determines which version of the Article is returned.'Authoring' returns the most recent version of an Article checked-in by an author.'Staging' returns the updated version currently being processed in a workflow.'Publish' returns the most recently published version.
Value in
- "authoring"
- "staging"
- "publish"
Pagination parameter that specifies the page number of results to be returned. Used in conjunction with $pagesize.
int641 <= value <= 9991Pagination parameter that specifies the number of results per page. Used in conjunction with $pagenum.
int641 <= value <= 7510The attributes of an Article to be returned in addition to the default list of attributes, listed below. Multiple additional attributes can be specified using a comma-separated list. Passing 'all' will return all attributes.
Default Attributes
These Article attributes are always returned:
| Name | Description |
|---|---|
| id | The ID of the Article. |
| name | The name of the Article. |
| articleType | The Article Type and its attributes. |
| createdBy | The ID, first name, middle name and last name of the user that created the Article. |
| createdDate | The date that the Article was created. |
| hasAttachments | True: The Article has one or more attachments.False: The Article does not have any attachments. |
| languageCode | The language code of the Article language. |
| modifiedBy | The ID, first name, middle name and last name of the user that last modified the Article. |
| modifiedDate | The date that the Article was last modified on. |
| link | The link object, used to retrieve the details of the Article. |
| versionId | The ID of the Article version that is returned. |
Header 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
application/json
curl -X GET "https://example.com/knowledge/portalmgr/v4/portals/PROD-1000/articles/subscribed?articleResultAdditionalAttributes=averageRating" \ -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"{ "articles": [ { "id": "PROD-2996", "name": "Fair Lending FAQs", "articleType": { "articleCategoryId": 0, "typeName": "General", "useStructuredAuthoring": false, "articleTypeId": "999300000002020" }, "createdBy": { "id": "1013", "firstName": "John", "middleName": "", "lastName": "Doe" }, "createdDate": "2022-06-30T14:54:55Z", "hasAttachments": true, "languageCode": "en-US", "modifiedBy": { "id": "1013", "firstName": "John", "middleName": "", "lastName": "Doe" }, "modifiedDate": "2025-01-28T19:53:58Z", "link": { "rel": "self", "href": "/knowledge/portalmgr/v4/portals/PROD-1000/articles/PROD-2996?filter%5Btopic%5D=PROD-1069&workflowMilestone=publish&%24lang=en-US" }, "versionId": "PROD-2884" } ], "paginationInfo": { "count": 1, "pagenum": 1, "pagesize": 10 }}Comply With an Article PUT
## Overview The Comply with an Article API allows the user to comply with an article by passing the Article's ID, which marks it as read by the user. ## Prerequisites * The user must be an agent and: * Be available in the portal. * Be available for the current user profile. * Have the Article's compliance policy enabled. * If the Article has Access Tags, then it must be available for the agent's current user profile. * If the Article has Publish Views, then at least one edition of the Article must be available for the agent's current user profile.
Subscribe to an Article PUT
## 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.

