During Integration with External Systems, it is often useful to have an Upsert call, that will create a record if it already doesn't exist else it will update.

​

Prerequisites

• Your unique Tenant ID, obtained from support.
• Your unique apiKey, as generated in Company Info.
• The Smart Object ID, obtained from the Smart Object page.
• Internal field names for the smart object, obtained from the field definitions.

Matching

The incoming data will be matched against existing record using Record Key  specified in Smart Object settings. This call will never update a record if the record key is specified to be 'Unique Random ID'.

​

Details

​

Method: POST

URL: https://us.pulpstream.com/vfr/api/smartObjectRecords/{smartObjectId}/upsert

 

Headers:

tenantId: {tenantId}

apiKey: {apiKey}

Content-Type: application/json

apiUserName: Optional. Specify internal username from the User definition to submit the data on behalf of that user.

Sample PayLoad:

{"Name":"Tesla",
 "Contact_Phone":"",
 "Address":"",
 "City":""}

}

where the payload contains field names and data values.
Fields contained in the payload replace fields in the target record.
Fields that are not present in the payload do not affect the target record.

​

Data Formats​

• User fields - Supply User ID or the internal username taken from the User definition.
• Date and Time fields - Supply value using ISO-8601 format in the time zone specified in company information.
• Photo or File Fields - First upload the file(s) using the File Upload API. 
  The returned value for each uploaded file can then be added to a
    File Attachments field defined in the object.
  For example: Site_Photos:['341231231231231_Client_Site.JPG', ...] 
  

​