Inserts or creates a history record. Although a history is a unique and searchable record, you will typically associate a history with another record (for example, an account), using the history to track changes made to the account.
Parameters
insertHistory Parameter Descriptions
Parameter Name |
Data Type |
Description |
history |
Data object |
Required Properties from historyCreate
The following table lists properties from the historyCreate data object that must be populated in order to create a history record. Also note that the same properties must be populated when you are updating a history record, using the historyUpdate data object.
historyCreate Required Properties
Property Name |
Data Type |
Description |
archivedOn |
dateTime |
The date the history record is created. For example, the current date. |
shortDescription |
string |
Description of the history or note about the related record's changes. Maximum: 250 characters. |
parentObject |
historyOwner |
The unique key of the record to associate the history record with. |
Response
insertHistory Response Descriptions
Parameter Name |
Data Type |
Description |
uniqueKey |
string |
The unique key of the newly created history record. |
See Also:
historyCreate for more information about the properties you can set for the history
