Invocable Actions for Lightning Knowledge
Actions for Lightning Knowledge can be invoked from a REST endpoint. Use these actions to manage your articles and article versions.
To learn more about how to use invocable actions, see the Actions Developer Guide.
Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations.
The Assign and Publish actions are available in API version 44.0 and later. All the other actions are available in API version 45.0 and later.
Lightning Knowledge must be set up in your org. The user must have permissions to manage articles.
You can use multiple inputs to an invocable action. This technique is useful for actions that don’t take lists, such as restoreKnowledgeArticleVersion.
| Action | URI |
|---|---|
| Archive Knowledge articles | /services/data/v{XX.X}/actions/standard/archiveKnowledgeArticles |
| Assign Knowledge articles | /services/data/v{XX.X}/actions/standard/assignKnowledgeArticles |
| Create draft from online Knowledge articles | /services/data/v{XX.X}/actions/standard/createDraftFromOnlineKnowledgeArticle |
| Delete Knowledge articles | /services/data/v{XX.X}/actions/standard/deleteKnowledgeArticles |
| Publish Knowledge articles | /services/data/v{XX.X}/actions/standard/publishKnowledgeArticles |
| Restore Knowledge article version | /services/data/v{XX.X}/actions/standard/restoreKnowledgeArticleVersion |
| Retrieve Smart Link URL | /services/data/v{XX.X}/actions/standard/getArticleSmartLinkUrl |
| Submit Knowledge article for translation | /services/data/v{XX.X}/actions/standard/submitKnowledgeArticleForTranslation |
| Property | Value |
|---|---|
| Formats | JSON, XML |
| HTTP Methods | GET, HEAD, POST |
| Authentication | Authorization: Bearer {token} |
| Other Information | Error Response Types |
URI: /services/data/v{XX.X}/actions/standard/archiveKnowledgeArticles
| Input | Type | Description |
|---|---|---|
| articleVersionIdList | string | Required. Comma-separated article version ID list. |
Sample Input
The following code sample archives two articles:
Sample Output
The following code sample illustrates a response after a successful request.
The following code sample illustrates a response with one success and one failure:
URI: /services/data/v{XX.X}/actions/standard/assignKnowledgeArticles
| Input | Type | Description |
|---|---|---|
| articleVersionIdList | string | Required. Comma-separated article version ID list. |
| assigneeId | ID | Required. ID of the assigned user. |
| assignAction | string | Required. Assign action. Valid actions are: ASSIGN_DRAFT_MASTER or ASSIGN_DRAFT_TRANSLATION. |
| dueDate | string | Optional. Assigned due date. |
| instruction | string | Optional. Instructions for the assignee. |
| sendEmailNotification | boolean | Optional. Indicates whether to send an email notification. Defaults to false. |
Sample Input
The following code sample assigns two articles for translation:
Sample Output
The following code sample illustrates a response after a successful request.
URI: /services/data/v{XX.X}/actions/standard/createDraftFromOnlineKnowledgeArticle
| Input | Type | Description |
|---|---|---|
| action | string | Required. Edit action for primary language or translation articles. Valid actions are: EDIT_AS_DRAFT_ARTICLE or EDIT_AS_DRAFT_TRANSLATION. |
| unpublish | boolean | Required. Indicates whether to keep the article published (false) or archive the published article (true). Use false to keep the current article version online and create a draft. Use true to archive the current online version, which removes it from the knowledge base, and creates a draft. |
| articleVersionId | string | Article version ID. Required to create a draft from an online (published) translation. Optional to create a draft from the online primary article if the Article ID is provided. |
| articleId | string | Article ID. Required when creating a draft from the online (published) primary article if the Article Version ID isn’t provided. |
Sample Input
The following code sample creates a draft from a primary article and archives the original article:
Sample Output
The following code sample illustrates a response after a successful request.
URI: /services/data/v{XX.X}/actions/standard/deleteKnowledgeArticles
| Input | Type | Description |
|---|---|---|
| articleVersionIdList | string | Required. Comma-separated article version ID list. |
Sample Input
The following code sample deletes two articles:
Sample Output
The following code sample illustrates a response after a successful request.
URI: /services/data/v{XX.X}/actions/standard/publishKnowledgeArticles
| Input | Type | Description |
|---|---|---|
| articleVersionIdList | string | Required. Comma-separated article version ID list. |
| pubAction | string | Required. Publish action. Valid actions are: PUBLISH_ARTICLE (which replaces the latest version), PUBLISH_ARTICLE_NEW_VERSION (which creates a new version), SCHEDULE_ARTICLE_FOR_PUBLICATION, or PUBLISH_TRANSLATION. |
| pubDate | string | Optional. Scheduled publish date in ISO 8601 format yyyy-MM-dd\'T\'HH:mm:ss.SSSZ. For example, for February 8, 2023, 1:40 pm UTC+01:00 use 2023-02-08T13:40:00.000+0100. |
Sample Input
The following code sample publishes two articles:
Sample Output
The following code sample illustrates a response after a successful request.
URI: /services/data/v{XX.X}/actions/standard/restoreKnowledgeArticleVersion
| Input | Type | Description |
|---|---|---|
| action | string | Required. The only valid action is: RESTORE_KNOWLEDGE_ARTICLE_VERSION |
| articleId | string | Required. Article ID. |
| versionNumber | integer | Optional. Version number of the archived article version to restore. Default is the latest archived version. |
Sample Input
The following code restores the latest archived version:
The following code restores a past archived version of a published article:
The following code restores two archived articles:
Sample Output
The following code sample illustrates a response after a successful request.
URI: /services/data/v{XX.X}/actions/standard/getArticleSmartLinkUrl
| Input | Type | Description |
|---|---|---|
| articleVersionId | string | Required. The ID of the Knowledge article version. |
Sample Input
The following code sample retrieves the SmartLink URL of a Knowledge article version:
Sample Output
The following code sample illustrates a response after a successful request.
URI: /services/data/v{XX.X}/actions/standard/submitKnowledgeArticleForTranslation
| Input | Type | Description |
|---|---|---|
| articleId | string | Required. Article ID. |
| language | string | Required. Language code for the translation. |
| assigneeId | ID | Required. ID of the assigned user. |
| dueDate | string | Optional. Assigned due date. |
| sendEmailNotification | boolean | Optional. Indicates whether to send an email notification. Defaults to false. |
| Output | Type | Description |
|---|---|---|
| articleId | ID | Article ID. |
| language | string | Language code for the translation. |
Sample Input
The following code sample submits one article for translation into Spanish:
Sample Output
The following code sample illustrates a response after a successful request.
Knowledge actions can respond with two types of error responses: action-scoped errors and item-scoped errors.
Action-scoped errors describe an error about the overall action that you’re trying to invoke. Action-scoped errors have a statusCode in addition to a message. This example illustrates an action-scoped error caused by sending invalid input values.
Item-scoped errors describe a problem with a specific article or article version within the action. For example, this code illustrates an archiveKnowledgeArticles action response with one failed item and one successful item.
If any type of error occurs with an action, the isSuccess field is false.