API Reference

Create a Knowledge Base Article

post
https://{account}.sysaidit.com/connect/v1/kb-articles

Create a new knowledge base article in your SysAid account. If the user is an End User, the API returns a 403 error. If another knowledge base import is in progress, the API returns a 429 error with a Retry-After header that gives the wait time in seconds. Do not send the request again after a 502 error. SysAid can create the article even when the API returns 502. Get the list of articles first. Before SysAid saves the article, it removes all semicolons from the text fields. It also replaces straight quotation marks around text that has no spaces with "«" and "»".

Body Params

The fields of a new knowledge base article. Only title and answer are required.

string
required
length between 1 and 255

The short title of the article, shown in search results and article lists. Use plain text. SysAid changes the characters "<" and ">" in the title.

string
length ≤ 10000

The question or problem that the article answers. If you do not send a value, or the value is empty, SysAid uses the title as the question.

string
required
length between 1 and 50000

The answer to the question, as HTML. SysAid keeps the allowed tags, for example <p>, <b> and <table>. SysAid changes other tags, for example script tags, to plain text. It also removes attributes that are not allowed, for example "class" and "style". SysAid replaces quotation marks around text that has no spaces with "«" and "»". Because of this change, a link address in a quoted attribute stops working.

string
length ≤ 64

The name of the top-level category of the article.

string
length ≤ 64

The name of the second-level category of the article, a child of the top-level category.

string
length ≤ 64

The name of the third-level category of the article, a child of the second-level category.

keywords
array of strings

The search keywords of the article. A keyword cannot contain a comma. All keywords together, separated by commas, can have a maximum of 255 characters. When you get the article, SysAid splits a keyword that contains a space into separate keywords.

keywords
boolean
Defaults to false

Whether the article is published. End Users can see a published article in the self-service portal. An unpublished article is a draft that only Agents and Admins can see. The default is "false".

boolean
Defaults to false

Whether the article expires. If the value is "true", you must send expireDate. End Users cannot see the article after that time. The default is "false".

date-time | null

The timestamp of when the article expires, in ISO 8601 format. This field is required if enableExpire is "true". In other cases, SysAid ignores it. When you get the article, the time is always midnight.

Responses

Updated about 23 hours ago

Did this page help you?
Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 23 hours ago

Did this page help you?