> ## Documentation Index
> Fetch the complete documentation index at: https://docs.blinkops.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Update Record Metadata

Update specific metadata fields on an existing record.

**Required OAuth scope:** `public.records.updateRecords`

> [!NOTE]
>
> External Documentation
>
> To learn more, visit the [Ironclad documentation](https://developer.ironcladapp.com/reference/update-record-metadata).

## 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:** <pre>`[  {    "recordId": "17009e0d-z2e9-425d-a85b-1cf152773e49"  }]`</pre> |
| 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:** <pre>`{  "counterpartyName": {    "type": "string",    "value": "Test LLC"  },  "agreementDate": {    "type": "date",    "value": "2018-05-08T00:00:00-07:00"  }}`</pre> |
| 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:** <pre>`[  {    "recordId": "17009e0d-z2e9-425d-a85b-1cf152773e49"  }]`</pre> |
| 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:** <pre>`[  {    "recordId": "17009e0d-z2e9-425d-a85b-1cf152773e49"  }]`</pre> |
| 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:** <pre>`{  "contractValue": {    "amendmentType": "replace"  }}`</pre> |
| 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:** <pre>`[  {    "recordId": "17009e0d-z2e9-425d-a85b-1cf152773e49"  }]`</pre> |
| 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

```json theme={"dark"}
{
	"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"
	]
}
```

## Workflow Library Example

[Update Record Metadata with Ironclad and Send Results Via Email](https://library.blinkops.com/workflows/update-record-metadata-with-ironclad-and-send-results-via-email)

![Workflow Library](https://mintcdn.com/blinkops-2/ojHYuDeYX5FWuN8a/img/Icons/play-box.svg?fit=max\&auto=format\&n=ojHYuDeYX5FWuN8a\&q=85\&s=b8af968e71438a9499c3223c9bd29fb2)

Preview this Workflow on desktop

[https://library.blinkops.com/workflows/update-record-metadata-with-ironclad-and-send-results-via-email/canvas](https://library.blinkops.com/workflows/update-record-metadata-with-ironclad-and-send-results-via-email/canvas)