Replace a Record

put

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

Update an existing record with a new set of metadata.

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

required

The type of record to be created. You can view available record types by retrieving records metadata.

name

string

required

The name of the record.

properties

object

required

Object containing key/value pairs of metadata attached to the record. The key you specify must have a value with a supported type as outlined in the Supported Property Types section.

parent

object

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

propertiesToAmend

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

children

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.

children

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

Language

Credentials

URL

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200200

400400