Sign in

v1

latestOpenAPI 3.1.02026-07-2498134321.1 KB
Records

Replace a Record

Update an existing record with a new set of metadata.

OAuth Scope required: public.records.updateRecords

put/records/{id}

Path parameters

idstring required

The ID or Ironclad ID of the Record.

Query parameters

addressAsObjectboolean

When true, returns addresses as objects instead of strings.

Headers

x-as-user-emailstring
Example:jane.doe@test.com

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-idstring
Example:5f0375c4cdc1927a3c5edcd3

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.

Request body

typestring required

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

namestring required

The name of the record.

propertiesToAmendPropertiesToAmend

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

Example request

{
  "parent": {
    "recordId": "17009e0d-z2e9-425d-a85b-1cf152773efg"
  },
  "propertiesToAmend": {
    "contractValue": {
      "amendmentType": "replace"
    },
    "terminationDate": {
      "amendmentType": "replace"
    }
  },
  "children": [
    {
      "recordId": "17009e0d-z2e9-425d-a85b-1cf152773e49"
    }
  ]
}

Response

200

idstring required

The unique identifier of the record

ironcladIdstring required

The unique Ironclad identifier of the record

typestring required

The type of the record

namestring required

The name of the record

lastUpdatedstring date-time required

The date (ISO8601 format) the record was last updated

propertiesRecordProperties required

The record properties associated with the record

attachmentsobject required

The attachments associated with the record keyed by the attachment key

parentIdstring

The unique identifier of the parent record

parentLinkType'amendment' | 'obligation'

Identifies the type of relationship this child record has with its parent (e.g. amendment)

childIdsstring[]

The unique identifiers of the child records

amendmentsstring[]

The unique identifiers of amendment records that amend this record

Example response

{
  "id": "22e2ff72-56a1-4711-a4ca-41328d311e9f",
  "ironcladId": "IC-1",
  "type": "consultingAgreement",
  "name": "Consulting Agreement with Jane Doe",
  "lastUpdated": "2018-05-08T17:28:10Z",
  "links": [
    {
      "recordId": "df1c2805-f5a3-4a14-9386-c28d950dff49"
    }
  ],
  "parentId": "d10b8c01-5c54-4a59-82cb-51e3825182e9",
  "childIds": [
    "4a785686-d3d5-47bc-960e-3df0df871ea9"
  ],
  "contractStatus": {
    "status": "active",
    "enhancedStatus": "auto-renewing",
    "remainingDuration": "P26D",
    "eventDate": "2024-07-02T00:00:00.000Z",
    "message": "Auto-renewing on Jul 2, 2024"
  },
  "source": {
    "type": "workflow",
    "workflowId": "workflow:4a785686-d3d5-47bc-960e-3df0df871ea9"
  },
  "amendments": [
    "IC-124"
  ]
}