GuidesAPI ReferenceRecipes
API Reference
Request a Demo

Create a Record

post
https://na1.ironcladapp.com/public/api/v1/records

Create a contract record by specifying its intended metadata properties. See more documentation on creating a record.

OAuth Scope required: public.records.createRecords

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
boolean
Defaults to false

When true, returns addresses as objects instead of strings.

Body Params
string
required

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

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.

links
array of objects
links
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
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.

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

Updated about 6 hours ago

Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 6 hours ago