public.records.updateRecords
External DocumentationTo learn more, visit the Ironclad documentation.
Basic Parameters
| Parameter | Description |
|---|---|
| Add Links | The records to link to the record, as a JSON array of objects containing the record IDs or Ironclad IDs. For example: |
| Add Properties | The metadata properties to add to the record, as a JSON object of property IDs and their typed values. You can get the available record properties using the List Records Metadata action.For example: |
| Name | The name of the record. |
| Parent Link Type | Select the type of relationship the record has with its parent. |
| Parent Record ID | The ID or Ironclad ID of the record to set as the parent of the record. You can get record IDs using the List Records action. |
| Record ID | The ID or Ironclad ID of the record. |
| Remove Links | The record links to remove, as a JSON array of objects containing the record IDs or Ironclad IDs. For example: |
| Remove Parent | Select to remove the parent record of the record. |
| Remove Properties | A comma-separated list of the record property IDs to remove. For Example: counterpartyAddress,agreementExpirationDate |
| Type | The type of the record. You can get the available record types using the List Records Metadata action. |
Advanced Parameters
| Parameter | Description |
|---|---|
| Add Children | The records to set as the child records of the record, as a JSON array of objects containing the record IDs or Ironclad IDs. For example: |
| Add Properties To Amend | The properties to start deriving from this amendment record to its parent, as a JSON object of property IDs and their amendment behavior. For example: |
| Address As Object | Select to return address properties as objects instead of strings. |
| Remove Children | The child records to remove from the record, as a JSON array of objects containing the record IDs or Ironclad IDs. For example: |
| Remove Properties To Amend | A comma-separated list of the property IDs to stop deriving from this amendment record to its parent. For Example: contractValue,terminationDate |
Example Output
{
"id": "string",
"ironcladId": "string",
"type": "string",
"typeDisplayName": "string",
"name": "string",
"lastUpdated": "string",
"properties": {},
"attachments": {},
"links": [
{
"recordId": "string"
}
],
"parentId": "string",
"parentLinkType": "string",
"childIds": [
"string"
],
"contractStatus": {
"status": "string",
"enhancedStatus": "string",
"remainingDuration": "string",
"eventDate": "string",
"message": "string"
},
"source": {},
"amendments": [
"string"
]
}