> ## 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.

# Replace Record

Replace the metadata of an existing record with a new set of metadata.

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

<Note>
  External Documentation

  To learn more, visit the [Ironclad documentation](https://developer.ironcladapp.com/reference/replace-a-record).
</Note>

## Basic Parameters

<div className="integrations-table">
  | Parameter | Description |
  | - | - |
  | 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.<br /><br />**For example:**<br /><pre><code>\[<br />  \{<br />    "recordId": "17009e0d-z2e9-425d-a85b-1cf152773e49"<br />  }<br />]</code></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. |
  | Properties | The metadata properties to attach 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.<br /><br />**For example:**<br /><pre><code>\{<br />  "counterpartyName": \{<br />    "type": "string",<br />    "value": "Test LLC"<br />  },<br />  "agreementDate": \{<br />    "type": "date",<br />    "value": "2018-05-08T00:00:00-07:00"<br />  }<br />}</code></pre> |
  | Record ID | The ID or Ironclad ID of the record. |
  | Type | The type of the record. You can get the available record types using the `List Records Metadata` action. |
</div>

## Advanced Parameters

<div className="integrations-table">
  | Parameter | Description |
  | - | - |
  | Address As Object | Select to return address properties as objects instead of strings. |
  | Properties To Amend | The properties to amend from this amendment record to its parent, as a JSON object of property IDs and their amendment behavior.<br /><br />**Note**: Only valid when `Parent Link Type` is `amendment`.<br /><br />**For example:**<br /><pre><code>\{<br />  "contractValue": \{<br />    "amendmentType": "replace"<br />  }<br />}</code></pre> |
</div>

## 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

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

<div className="iframe-wrapper">
  <div className="iframe-media">
    <img src="https://mintcdn.com/blinkops-2/ojHYuDeYX5FWuN8a/img/Icons/play-box.svg?fit=max&auto=format&n=ojHYuDeYX5FWuN8a&q=85&s=b8af968e71438a9499c3223c9bd29fb2" alt="Workflow Library" width="16" height="16" data-path="img/Icons/play-box.svg" />

    Preview this Workflow on desktop
  </div>

  <iframe className="iframe" src="https://library.blinkops.com/workflows/replace-record-with-ironclad-and-send-results-via-email/canvas" />
</div>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.