0
edits
Changes
m
no edit summary
# Within your SmartSimple instance, define an API function within the Global Settings -> Integrations -> SmartConnect API screen.
# In this screen you will find options for ''Object Record Type'', ''Action Type'', and ''Field List'' that define respectively, the type of record, the action to perform, and the field list that will be exposed for this function.
# After saving your function, take note of the ''API Token'' as you will need to include this in your API calls to identify this pre-defined function.
==Usage==
===Posting Endpoints===
To make an API call you will need to post to the appropriate endpoint which will simply be based on the ''Object TypeRecord Type'' of the API function. The general endpoint will be in the form of:
/API/''APIVersion''/''objecttyperecordtype''/
The full list of endpoints is below.
{| class="wikitable"
|-
!|Object Record Type
!|Endpoint
!|Example
===Message Body===
The message body that you post will need to include various parameters depending on the ''Object TypeRecord 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. At minimum though, you will always need to include:
* '''url''': The URL to post to.
For a list of available Standard Fields that you can reference along with update restrictions, see [[JSON API (SmartConnect) Standard Field Names|SmartConnect Standard Field Names]].
The standard fields available for reference varies on the Record Type selectedin the API call.
==Options and Settings==
<!--Explain all applicable misc options and settings that shouldn't be explained above here...-->
===Available Object TypesRecord Types===
{| class="wikitable"
|-
===Available Action Types===
The following is a full list of available actions. Please note that not all actions will be available for all object typesrecord types.
{| class="wikitable"
|-
||Variables Replace
||Returns formatted content processed by the variable processor from a specified record. The system will replace all variables within the content parameter with variable values from that objectrecord. E.g. Passing in "Hello @firstname@" as content for a contact name named John Smith will return "Hello John".
|}
