Untitled Page
API Overview
Example
Customers  
Companies  
Technicians  
Technician Groups  
Tickets  
Ticket History  
Ticket Attachments  
Billing Line Items  
Billing Invoices  
Time Tracking  
Knowledge Base Articles  
Scheduling  
Asset Managements  
 
add_kb_article and update_kb_article
The variables and values are the same for both add_kb_article and update_kb_article (with the exception of "id", which is only used by update_kb_article). However, when using update_asset, only the variables and values you supply will be updated.
Input Variable Input Value Description
title String value, limited to 255 characters. Required The title of the article.
category String value. The article category name.
description String value, no charachter limit. Required A comma delimited list of customer IDs to associate with the asset.
details String value, no charachter limit. Required A vertical pipe delimited list of asset field names.
additional_information1 String value, no charachter limit. A vertical pipe delimited list of asset field names.
additional_information2 String value, no charachter limit. A vertical pipe delimited list of asset field names.
internal_only String value Defines if the article will be internal only, meaning it can only be viewed by technicians and admins. Accepted values are "N" and "Y".
externally_viewable String value Defines if the article can be viewed outside of the customer portal, on the portal login page. Accepted values are "N" and "Y".
external_only String value Defines if the article should only be displayed outside of the customer portal, on the portal login page. Accepted values are "N" and "Y".
customer_portals String value. A comma separated list of customer portal IDs, which defines the customer portals the article should be viewable in.

Output Variable URL Encoded Description
add_kb_article No Article ID that was added.
Example Usage
http://localhost/API/default.aspx?key=your key here&action=add_kb_article&title=Sample Article&description=Sample article description&details=Sample resolution 1
Example Response
XML:
<?xml version="1.0"?>
<response>
    <added_article>5</added_article>
</response>
JSON:
{
	"response": [
		{
			"added_article" : "5"
		}
	]
}
URL DELIMITED:
added_article=5