Comply With an Article

Overview

  • This API allows to comply with an article.
  • For this API to execute successfully, the article :
    • Available in portal
    • Available for current user profile.
    • Compliance policy is enabled on article.

Permission

  • User must be an agent.
  • If article has Access Tags, article must be available for agent's current user profile.
  • If article has Publish Views, at least one edition of article must be available for agent's current user profile.
SecurityoAuthUser
Request
path Parameters
portalID
required
number
Example: 202200000001001
articleID
required
string

The Id of the article on which operation is performed. Both numeric and alternate Id formats are supported for article Id.

Examples:
Providing readable article id.
PROD-2268
Providing numeric article id.
202200000002268
header Parameters
Accept-Language
required
string
Default: en-US

Language locale accepted by client (used for locale specific fields in resource representation and in error responses).

Enum: "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"
X-egain-tenant-id
string

Unique identifier for tenant.

X-egain-activity-id
integer

Numeric unique identifier of interaction from eGain.

X-interaction-id
string

Unique identifier for interaction from other CRM applications.

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}/comply
Request samples
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>"
}