Article

Add as Reference

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

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 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
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"
Accept*"application/json"

The content type accepted by the client.

Default"application/json"

Value in

  • "application/json"

Request Body

application/json

versionId*string

An Article version's ID.

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

An Article edition's ID.

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

The 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/addasreference" \  -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"    }  }'
Empty

Add Article to Reply PUT

## Overview The Add Article to Reply API captures events for articles used in a reply for 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.

Get Articles in Topic GET

## Overview The Get Articles in Topic API allows a user to retrieve the browsable articles in a topic. ## Prerequisites * Set the Article type’s parameter “Include in browse on portals” to "Yes" for an article to be returned by this API. * Agents without a user profile and customers in a portal without a default user profile only have access to articles that: * Do not contain any access tags. * Do not contain any publish views. * Contain published views without any associated tags. * Agents with a user profile and customers in a portal with a default user profile have access to articles that: * Do not contain any access tags. * Do not contain any publish views. * Contain publish views without any associated tags. * Contain access tags that are also in the assigned user profiles. * Contain publish views with associated tags that are also in the assigned user profiles. ## Permissions * Agents with the following assigned actions can view updates to articles currently being processed in workflows: * View Author Portal – Allows agents to view updates to articles at any stage in a workflow. * View Staging Portal – Allows agents to view updates to articles in the Staging stage or a subsequent stage in a workflow.