Update Record Metadata

patch

https://na1.ironcladapp.com/public/api/v1/records/{id}

Update specific fields on a record.

OAuth Scope required: public.records.updateRecords

Path Params

string

required

The ID or Ironclad ID of the Record.

Query Params

addressAsObject

boolean

Defaults to false

When true, returns addresses as objects instead of strings.

Body Params

type

string

The type of Record.

name

string

The name of the Record.

addProperties

object

A key:value map of properties to add. The two below are examples.

removeProperties

array of strings

List of record property ids to be removed (e.g., ['counterpartyAddress', 'agreementExpirationDate'])

removeProperties

addLinks

array of objects

List of objects containing the Record IDs or Ironclad IDs of the records to link. For an explanation of Record IDs or Ironclad IDs and how to find them, see Getting Started.

addLinks

removeLinks

array of objects

List of objects containing the Record IDs or Ironclad IDs of the record links to remove. For an explanation of Record IDs or Ironclad IDs and how to find them, see Getting Started.

removeLinks

setParent

object

Object containing Record IDs or Ironclad IDs to be set as the parent of the current record.

addChildren

array of objects

List of objects containing the Record IDs or Ironclad IDs of the records to be set as child records of the current record.

addChildren

removeParent

boolean

Boolean flag to indicate if the parent id should be removed for the current record.

removeChildren

array of objects

List of objects containing the Record IDs or Ironclad IDs of the child records to be removed from the current record.

removeChildren

addPropertiesToAmend

object

Configuration specifying which properties should be amended from this amendment record to its parent. Keys are property names, values define the amendment behavior. Only valid when parentLinkType is 'amendment'.

removePropertiesToAmend

array of strings

List of property IDs to stop deriving from this amendment record to the parent record. Removes existing derived property relationships, allowing the parent record to revert to its non-amended value for those fields.

removePropertiesToAmend

Headers

x-as-user-email

string

Denotes the actor of the request. When used, the API will take into account this user's permissions and access. This or x-as-user-id is required when the associated token was produced from the Client Credentials grant or with legacy bearer tokens on select endpoints. More information about permissions.

x-as-user-id

string

Denotes the actor of the request. When used, the API will take into account this user's permissions and access. This or x-as-user-email is required when the associated token was produced from the Client Credentials grant or with legacy bearer tokens on select endpoints. More information about permissions.

Responses

200200

400400

404404