Smartstaff
124
edits
Changes
no edit summary
<!--1136148 - SmartConnect API version 2-->
As of August 2022 upgrade, APIVersion=2 is now available. This version has standardized syntax and format of requests and responses.
===Message Body===
The message body that you post will need to include various parameters depending on the ''Record Type'' and ''Action Type'' being used. The required and optional parameters will be listed for each different function on the configuration page of each SmartConnect function.
e.g. criteria:[{"andor":"and","field":"cf_123456","operator":"isempty","value":"true"}]
===Exclude (or include) archived UTA Records===
New parameters introduced to exclude archived UTA records and should be put inside the "'''othersettings'''" in json object for the API call<br />'''includearchive''' - if you don't put this node or use {"includearchive":1} , it will include everything in the search, to exclude archived records, set the parameter to 0<br />e.g. if you want to set pagination for 100 per page and '''exclude''' archived UTA records:<br />othersettings: {"recordsperpage":100,'''"includearchive":0'''}'''<br />'''
===Hourly API Call Limit===
<!--125991 - Throttle API calls-->
API calls in excess of 1000 per instance within the past hour will receive an error and blocked from using API until the total API calls count in the last hour drops below the limit.
=SmartConnect Examples=
See our [https://api.smartsimple.com/devtools/api.html interactive demonstration page] for a demo and live sample of how the API works. This page is connected to a specific demonstration instance containing sample data.