View as Markdown
Ironclad icon

Ironclad ACTION

Create Record

Creates a new record in Ironclad. Provide properties as a JSON object where each key maps to a {type, value} wrapper. Run Describe Workspace first to see all valid record types and property keys (with their required type) in one call; List Type Options / List Properties Options exist only to resolve a single value for this action's props, not for general discovery. Property types are snake_case, e.g. string, number, monetary_amount, address, date, duration, booleannot the camelCase types used by workflow attributes. Complex types use nested objects: monetary_amount {"currency": "USD", "amount": 25.37}, address {"lines": ["325 5th Street", "Suite 200"], "locality": "San Francisco", "region": "California", "postcode": "94107", "country": "USA"}. Example: set recordName to "Acme NDA", recordType to "vendor_agreement", and properties to {"counterpartyName": {"type": "string", "value": "Acme Corp"}, "contractValue": {"type": "monetary_amount", "value": {"currency": "USD", "amount": 50000}}}; returns {"id": "rec_abc123", "name": "Acme NDA"}. See the documentation
  • Action
  • Writes data
  • OAuth
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Ironclad account once, then configure and run Create Record from your backend or agent.

import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const result = await pd.actions.run({
  id: "ironclad-create-record",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    ironclad: { authProvisionId: "apn_xxxxxxx" },
    recordName: "Name",
    recordType: "Type",
  },
})

console.log(result)

SCHEMA

Inputs

Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.

Create Record inputs
Property Type Description
recordName Name string
Name of the record.
Required
recordType Type string
The record type identifier. Call List Type Options to discover valid type keys (e.g. vendor_agreement).
Required Dynamic
properties Properties string
JSON object of property key to {type, value} wrapper pairs. Run Describe Workspace first to discover valid keys and their exact required type (e.g. string, number, boolean, monetary_amount, address, date, duration) — do not guess the type. Example: {"counterpartyName": {"type": "string", "value": "Acme Corp"}, "contractValue": {"type": "monetary_amount", "value": {"currency": "USD", "amount": 50000}}}.
Required
links Links string[]
Array of record IDs to link to the new record. Run Search Records first to find valid record IDs.
Optional Dynamic
parent Parent string
Record ID to set as the parent of this record. Run Search Records first to find valid record IDs.
Optional Dynamic
children Children string[]
Array of record IDs to set as child records. Run Search Records first to find valid record IDs.
Optional Dynamic

REFERENCE

Tool details

Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.

Registry key
ironclad-create-record
Version
1.0.1
App
Ironclad
Authentication
OAuth
Read-only
No
Destructive
No
Open world
Yes