HELP FILE

Knowledge-base create and update article API

CreateArticle

Use this protocol to create a new Article in the Knowledge Base or Publishing Center.

<nR>
<CreateArticle username='*USERNAME@ACCOUNT*' password='*PASSWORD*' status='*STATUS*'>
<kb><![CDATA[*KNOWLEDGE BASE NAME*]]></kb>
<title><![CDATA[*NEW TITLE*]]></title>
<body><![CDATA[*NEW BODY*]]></body>
<labels>*LABELS_CSV*</labels>
<context>*CONTEXT (format: category1:value1,category2:value2)</context>
</CreateArticle>
</nR>

Method

The protocol should be sent via HTTP POST request to the Bold360 ai server using the URL:

http://my.Nanorep.com/KB

Parameter Usage Example
username Your Bold360 ai login name. You must have knowledge base access privileges in order to use the API (required) username='john@company'
password Your Bold360 ai password (required) password='1234567'
status Article status: use 'kb' for online, 'pc' for publishing center (required) status='kb'
kb The name of the knowledge base to use. If you don't know the name of the knowledge base, use the language name eg.: English (required) <kb><![CDATA[English]]></kb>
title Title of the item (required) <title><![CDATA[Winter Sale]]></title>
body Body of the item (required) <body><![CDATA[We're cutting prices]]></body>
labels Adds one or more labels to the new item. Value must be comma-separated IDs of Knowledge Base labels (optional) <labels>1234,ABCD</labels>
context Specify the context of the new item. (optional) <context>Product:iPad,Category:Tablets</context>

UpdateArticle

Use this protocol to create update an Article. This affects articles in the Knowledge Base and the Publishing Center.

<nR>
<UpdateArticle username='*USERNAME@ACCOUNT*' password='*PASSWORD*' id='*ARTICLE_ID*'>
<kb><![CDATA[*KNOWLEDGE BASE NAME*]]></kb>
<title><![CDATA[*NEW TITLE*]]></title>
<body><![CDATA[*NEW BODY*]]></body>
<labels>*LABELS_CSV*</labels>
<context>*CONTEXT (format: category1:value1,category2:value2)</context>
</UpdateArticle>
</nR>

Method

The protocol should be sent via HTTP POST request to the Bold360 ai server using the URL:

http://my.Nanorep.com/KB

Parameter Usage Example
username Your Bold360 ai login name. You must have knowledge base access privileges in order to use the API (required) username='john@company'
password Your Bold360 ai password (required) password='1234567'