Add As Reference

Overview

  • Captures Events for Articles that are referenced by agents for replying in a digital channel activity.

Permission

  • Only Agents can invoke this API.

Headers

  • One of x-egain-activity-id or x-interaction-id header must be provided
SecurityoAuthUser
Request
path Parameters
portalID
required
string
Example: 999900000000000
articleID
required
string
Example: 999900000000000
header Parameters
X-egain-tenant-id
string

Unique identifier for tenant.

Accept
string
Example: application/json
X-egain-activity-id
string
X-interaction-id
string
Example: d9fc85fd-f36b-4625-a5a5-b71f8b626ad5
Request Body schema: application/json
versionId
required
number

Article Reference ID

editionId
number

Article Edition ID

Responses
204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

406

Not acceptable

500

Internal server error

put/portals/{portalID}/articles/{articleID}/addasreference
Request samples
application/json
{
  • "editionId": 409600000013015,
  • "versionId": 409600000012516
}
Response samples
application/json

Required query parameter is missing

{
  • "code": "400-112",
  • "developerMessage": "Required query parameter(s) is missing. The following parameters are required: <param name>"
}