Add Article to Reply
Overview
The Add Article to Reply API captures events for articles used in a reply for a digital channel activity.
Note: Either the x-ext-activity-id orx-ext-integration-id and x-ext-interaction-id header must be provided.
Permissions
- Only Agents can invoke this API.
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"
The content type accepted by the client.
"application/json"Value in
- "application/json"
Request Body
application/json
An Article version's ID.
^[a-zA-Z0-9]{2,4}-\d{4,15}$7 <= length <= 20An Article edition's ID.
^[a-zA-Z0-9]{2,4}-\d{4,15}$7 <= length <= 20The knowledge base language in which the version is created.
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/addtoreply" \ -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" \ -H "Accept: application/json" \ -H "Content-Type: application/json" \ -d '{ "editionId": "PROD-13015", "versionId": "PROD-12416", "language": { "code": "en-US" } }'Get All Article Types in a Department GET
## Overview The Get All Article Types in a Department API retrieves a list of all Article Types configured for a specific department.
Add as Reference PUT
## Overview The Add as Reference API captures events for articles that are referenced by agents replying inside of a digital channel activity. Note: Either the <code>x-ext-activity-id</code> or<br><code>x-ext-integration-id</code> and <code>x-ext-interaction-id</code> header must be provided. ## Permissions * Only Agents can invoke this API.

