# Ironclad

> Run contracts through Ironclad: launch workflows from templates, update their answers, approve, comment, pause, resume or cancel them, follow approvals and signatures, download documents, and manage repository records and their files.

App · 24 actions. Web page: https://docs.lodol.com/docs/integrations/ironclad

## Actions

### Add comment

Post a comment on a workflow's activity feed as the connection's user. Mention someone with <@their email>.

**Inputs**

- Workflow (`ironclad_workflow_id`, text, required): The workflow's ID or its Ironclad ID (such as IC-123), from 'List workflows', an earlier step or the end of the workflow's address.
- Comment (`message`, text, required): What to say. Mention someone with <@jo@example.com>.
- Reply to (`reply_to_comment_id`, text): The ID of a comment to reply to, from 'List comments'.
- Add mentioned people to the workflow (`add_mentioned_people`, true/false): Needed when you mention someone who is not yet on the workflow.

**Outputs**

- `comment` (object): A comment

**Example output**

```json
{
  "comment": {
    "author": {
      "displayName": "Jo Bloggs",
      "email": "jo@example.com",
      "type": "internalUser"
    },
    "commentMessage": "Sent to Acme for review.",
    "id": "8asdkyrhl",
    "isExternal": false,
    "timestamp": "2026-10-21T09:10:00.000Z"
  }
}
```

### Add record attachment

Attach a file to a record, such as its signed copy. Ironclad refuses a second file of the same kind on one record.

**Inputs**

- Record (`record_id`, text, required): The record's ID or its Ironclad ID (such as IC-123), from 'List records' or an earlier step.
- Attachment kind (`attachment_key`, text, required): Which of the record's files, such as the signed copy. Pick one, or type a new name to add a kind of your own.
- File (`file`, text, required): Upload a file, use one from an earlier step, or give a public link to one (PDF, Word, Excel, images and more).
- File name (`filename`, text): The name to save it under, with its extension such as .pdf. Defaults to the file's own name.

**Outputs**

- `attachment_key` (text): The attachment kind it was saved under
- `filename` (text): The file's name
- `record_id` (text): The record's ID
- `size_bytes` (number): The file's size in bytes

**Example output**

```json
{
  "attachment_key": "signedCopy",
  "filename": "Mutual NDA - Acme LLC.pdf",
  "record_id": "22e2ff72-56a1-4711-a4ca-41328d311e9f",
  "size_bytes": 84213
}
```

### Approve workflow

Approve a workflow for an approver role, or withdraw that approval. Only the role's assigned user can, and only when it is that role's turn in the Review step.

**Inputs**

- Workflow (`ironclad_workflow_id`, text, required): The workflow's ID or its Ironclad ID (such as IC-123), from 'List workflows', an earlier step or the end of the workflow's address.
- Approver role (`role_id`, text, required): The approval to give, such as Legal. Pick one, or give its role ID from 'List approvals'.
- Decision (`decision`, text): Approve, or withdraw an approval given earlier. One of: `approved` (Approve), `pending` (Withdraw approval). Default: `approved`.
- Approve as (`approver_email`, text): The email of the user assigned to the role. Leave empty to approve as the connection's user.

**Outputs**

- `approver_email` (text): Who it was given as
- `role_id` (text): The approver role
- `status` (text): approved, or pending once withdrawn
- `workflow_id` (text): The workflow's ID

**Example output**

```json
{
  "approver_email": "jo@example.com",
  "role_id": "legal",
  "status": "approved",
  "workflow_id": "6013609108b8f070cee94fc1"
}
```

### Cancel workflow

Cancel a workflow, posting the reason on its activity feed.

**Inputs**

- Workflow (`ironclad_workflow_id`, text, required): The workflow's ID or its Ironclad ID (such as IC-123), from 'List workflows', an earlier step or the end of the workflow's address.
- Reason (`reason`, text, required): Why, posted as a comment on the workflow's activity feed.

**Outputs**

- `reason` (text): The reason posted with it
- `status` (text): Its status now
- `workflow_id` (text): The workflow's ID

**Example output**

```json
{
  "reason": "Deal closed lost in the CRM.",
  "status": "cancelled",
  "workflow_id": "6013609108b8f070cee94fc1"
}
```

### Create record

Add a contract record to the repository, with its type, name and fields.

**Inputs**

- Record type (`record_type`, text, required): The kind of contract. Pick one, or give its ID.
- Name (`name`, text, required): The record's name, as the repository shows it.
- Fields (`fields`, object): The record's fields and their values. Dates, numbers, yes or no, money (1500 USD) and lengths of time (2 years) are converted for you.

**Outputs**

- `record` (object): The record

**Example output**

```json
{
  "record": {
    "attachments": {
      "signedCopy": {
        "filename": "Mutual NDA - Acme LLC.pdf",
        "href": "https://na1.ironcladapp.com/public/api/v1/records/22e2ff72-56a1-4711-a4ca-41328d311e9f/attachments/signedCopy"
      }
    },
    "id": "22e2ff72-56a1-4711-a4ca-41328d311e9f",
    "ironcladId": "IC-1042",
    "lastUpdated": "2026-10-21T09:05:00Z",
    "links": [],
    "name": "Mutual NDA with Acme LLC",
    "properties": {
      "agreementDate": {
        "type": "date",
        "value": "2026-10-21T00:00:00Z"
      },
      "counterpartyName": {
        "type": "string",
        "value": "Acme LLC"
      }
    },
    "type": "mutualNDA",
    "typeDisplayName": "Mutual NDA"
  }
}
```

### Delete record

Delete a record from the repository, with its attachments.

**Inputs**

- Record (`record_id`, text, required): The record's ID or its Ironclad ID (such as IC-123), from 'List records' or an earlier step.

**Outputs**

- `deleted` (true/false): Always true once deleted
- `record_id` (text): The record deleted

**Example output**

```json
{
  "deleted": true,
  "record_id": "22e2ff72-56a1-4711-a4ca-41328d311e9f"
}
```

### Download record attachment

Download one of a record's files, such as its signed copy, and save it in Lodol for a later step.

**Inputs**

- Record (`record_id`, text, required): The record's ID or its Ironclad ID (such as IC-123), from 'List records' or an earlier step.
- Attachment kind (`attachment_key`, text, required): Which of the record's files, such as the signed copy. Pick one, or type a new name to add a kind of your own.

**Outputs**

- `attachment_key` (text): The attachment kind
- `content_type` (text): The file's type
- `document_ref` (text): The saved file, to use in a later step
- `filename` (text): The file's name
- `record_id` (text): The record's ID
- `size_bytes` (number): The file's size in bytes
- `url` (text): A link to open the saved file in Lodol

**Example output**

```json
{
  "attachment_key": "signedCopy",
  "content_type": "application/pdf",
  "document_ref": "doc_4b7c1e2a9d3f45c88a1e6f0b2d5c7e91",
  "filename": "Mutual NDA - Acme LLC.pdf",
  "record_id": "22e2ff72-56a1-4711-a4ca-41328d311e9f",
  "size_bytes": 84213,
  "url": "/actions/core/serve-document/doc_4b7c1e2a9d3f45c88a1e6f0b2d5c7e91?teamId=6512a1b2c3d4e5f600000001"
}
```

### Download workflow document

Download a workflow document's latest version and save it in Lodol, to attach or send in a later step.

**Inputs**

- Workflow (`ironclad_workflow_id`, text, required): The workflow's ID or its Ironclad ID (such as IC-123), from 'List workflows', an earlier step or the end of the workflow's address.
- Document (`document_key`, text, required): The document's key, from 'List workflow documents'.

**Outputs**

- `content_type` (text): The file's type
- `document_key` (text): The document's key
- `document_ref` (text): The saved file, to use in a later step
- `filename` (text): The file's name
- `size_bytes` (number): The file's size in bytes
- `url` (text): A link to open the saved file in Lodol
- `workflow_id` (text): The workflow's ID

**Example output**

```json
{
  "content_type": "application/pdf",
  "document_key": "rJklwCHQ",
  "document_ref": "doc_4b7c1e2a9d3f45c88a1e6f0b2d5c7e91",
  "filename": "Mutual NDA - Acme LLC.pdf",
  "size_bytes": 84213,
  "url": "/actions/core/serve-document/doc_4b7c1e2a9d3f45c88a1e6f0b2d5c7e91?teamId=6512a1b2c3d4e5f600000001",
  "workflow_id": "6013609108b8f070cee94fc1"
}
```

### Get launch form

Get a template's launch form: each field's ID, question, type and choices, which are required, and an example answer for each required field to start from in 'Launch workflow'.

**Inputs**

- Workflow template (`template_id`, text, required): The published workflow template. Pick one, or give its ID.

**Outputs**

- `count` (number): How many fields
- `example_fields` (object): An example answer for each required field, by field ID, in the form 'Launch workflow' takes
- `fields` (list): The form's fields
- `name` (text): The template's name
- `required_fields` (list): IDs of the fields that must be answered
- `template_id` (text): The template's ID

**Example output**

```json
{
  "count": 1,
  "example_fields": {
    "counterpartyName": "Lodol test"
  },
  "fields": [
    {
      "choices": [],
      "default": null,
      "id": "counterpartyName",
      "name": "Counterparty Name",
      "other_answers_allowed": false,
      "required": "always",
      "type": "string"
    }
  ],
  "name": "Mutual NDA",
  "required_fields": [
    "counterpartyName"
  ],
  "template_id": "600b296c3e15a234ab88f884"
}
```

### Get record

Get one record with its fields, attachments and linked records.

**Inputs**

- Record (`record_id`, text, required): The record's ID or its Ironclad ID (such as IC-123), from 'List records' or an earlier step.

**Outputs**

- `record` (object): The record

**Example output**

```json
{
  "record": {
    "attachments": {
      "signedCopy": {
        "filename": "Mutual NDA - Acme LLC.pdf",
        "href": "https://na1.ironcladapp.com/public/api/v1/records/22e2ff72-56a1-4711-a4ca-41328d311e9f/attachments/signedCopy"
      }
    },
    "id": "22e2ff72-56a1-4711-a4ca-41328d311e9f",
    "ironcladId": "IC-1042",
    "lastUpdated": "2026-10-21T09:05:00Z",
    "links": [],
    "name": "Mutual NDA with Acme LLC",
    "properties": {
      "agreementDate": {
        "type": "date",
        "value": "2026-10-21T00:00:00Z"
      },
      "counterpartyName": {
        "type": "string",
        "value": "Acme LLC"
      }
    },
    "type": "mutualNDA",
    "typeDisplayName": "Mutual NDA"
  }
}
```

### Get workflow

Get one workflow: its answers, step, status, roles, approval and signing state, and each field's type.

**Inputs**

- Workflow (`ironclad_workflow_id`, text, required): The workflow's ID or its Ironclad ID (such as IC-123), from 'List workflows', an earlier step or the end of the workflow's address.

**Outputs**

- `workflow` (object): The workflow

**Example output**

```json
{
  "workflow": {
    "approvals": {
      "state": "in_progress"
    },
    "attributes": {
      "agreementDate": "2026-10-21",
      "counterpartyName": "Acme LLC"
    },
    "created": "2026-10-21T09:00:00.000Z",
    "creator": {
      "displayName": "Jo Bloggs",
      "email": "jo@example.com",
      "id": "63d415e0dd0d828c3a878548"
    },
    "id": "6013609108b8f070cee94fc1",
    "ironcladId": "IC-1042",
    "lastUpdated": "2026-10-21T09:05:00.000Z",
    "recordIds": [],
    "recordType": "mutualNDA",
    "roles": [
      {
        "assignees": [
          {
            "email": "jo@example.com",
            "userId": "63d415e0dd0d828c3a878548",
            "userName": "Jo Bloggs"
          }
        ],
        "displayName": "Legal",
        "id": "legal"
      }
    ],
    "schema": {
      "agreementDate": {
        "displayName": "Agreement Date",
        "type": "date"
      },
      "counterpartyName": {
        "displayName": "Counterparty Name",
        "type": "string"
      }
    },
    "signatures": {
      "state": "not_started"
    },
    "status": "active",
    "step": "Review",
    "template": "600b296c3e15a234ab88f884",
    "title": "Mutual NDA with Acme LLC"
  }
}
```

### Launch workflow

Launch a workflow from a template, answering its launch form. It starts as the connection's user, who needs permission to start that template.

**Inputs**

- Workflow template (`template_id`, text, required): The published workflow template. Pick one, or give its ID.
- Fields (`fields`, object): Answers to the template's launch form. Dates, numbers, yes or no, money (1500 USD) and lengths of time (2 years) are converted for you; a document field takes a file or a public link to one.
- Use the form's default answers (`use_default_answers`, true/false): Fill fields left empty with the defaults the template sets. On unless turned off. Default: `true`.

**Outputs**

- `workflow` (object): The workflow

**Example output**

```json
{
  "workflow": {
    "approvals": {
      "state": "in_progress"
    },
    "attributes": {
      "agreementDate": "2026-10-21",
      "counterpartyName": "Acme LLC"
    },
    "created": "2026-10-21T09:00:00.000Z",
    "creator": {
      "displayName": "Jo Bloggs",
      "email": "jo@example.com",
      "id": "63d415e0dd0d828c3a878548"
    },
    "id": "6013609108b8f070cee94fc1",
    "ironcladId": "IC-1042",
    "lastUpdated": "2026-10-21T09:05:00.000Z",
    "recordIds": [],
    "recordType": "mutualNDA",
    "roles": [
      {
        "assignees": [
          {
            "email": "jo@example.com",
            "userId": "63d415e0dd0d828c3a878548",
            "userName": "Jo Bloggs"
          }
        ],
        "displayName": "Legal",
        "id": "legal"
      }
    ],
    "signatures": {
      "state": "not_started"
    },
    "status": "active",
    "step": "Review",
    "template": "600b296c3e15a234ab88f884",
    "title": "Mutual NDA with Acme LLC"
  }
}
```

### List approvals

List a workflow's approvals: each approver role, who holds it, whether it has approved, and which are waiting on their turn now.

**Inputs**

- Workflow (`ironclad_workflow_id`, text, required): The workflow's ID or its Ironclad ID (such as IC-123), from 'List workflows', an earlier step or the end of the workflow's address.

**Outputs**

- `all_approved` (true/false): True once every approval is given
- `approvals` (list): Every approval triggered so far
- `awaiting` (list): The approvals whose turn it is now
- `count` (number): How many
- `title` (text): The workflow's title
- `workflow_id` (text): The workflow's ID

**Example output**

```json
{
  "all_approved": false,
  "approvals": [
    {
      "assignees": [
        {
          "email": "jo@example.com",
          "name": "Jo Bloggs",
          "user_id": "63d415e0dd0d828c3a878548"
        }
      ],
      "can_approve_now": true,
      "group_order": 1,
      "group_status": "active",
      "role_id": "legal",
      "role_name": "Legal",
      "status": "pending"
    }
  ],
  "awaiting": [
    {
      "assignees": [
        {
          "email": "jo@example.com",
          "name": "Jo Bloggs",
          "user_id": "63d415e0dd0d828c3a878548"
        }
      ],
      "can_approve_now": true,
      "group_order": 1,
      "group_status": "active",
      "role_id": "legal",
      "role_name": "Legal",
      "status": "pending"
    }
  ],
  "count": 1,
  "title": "Mutual NDA with Acme LLC",
  "workflow_id": "6013609108b8f070cee94fc1"
}
```

### List comments

List the comments on a workflow's activity feed, one page at a time.

**Inputs**

- Workflow (`ironclad_workflow_id`, text, required): The workflow's ID or its Ironclad ID (such as IC-123), from 'List workflows', an earlier step or the end of the workflow's address.
- Page (`page`, number): Which page of results, from 1. Defaults to the first. At least 1.
- Page size (`page_size`, number): How many per page, 1 to 100. Ironclad's default is 20. From 1 to 100.

**Outputs**

- `comments` (list): The comments
- `count` (number): How many on this page
- `has_more` (true/false): True when there is a next page
- `page` (number): Which page this is, from 1
- `total` (number): How many match in all

**Example output**

```json
{
  "comments": [
    {
      "author": {
        "displayName": "Jo Bloggs",
        "email": "jo@example.com",
        "type": "internalUser"
      },
      "commentMessage": "Sent to Acme for review.",
      "id": "8asdkyrhl",
      "isExternal": false,
      "timestamp": "2026-10-21T09:10:00.000Z"
    }
  ],
  "count": 1,
  "has_more": false,
  "page": 1,
  "total": 1
}
```

### List record types and fields

List the repository's record types, record fields (with each one's ID and type) and kinds of attachment.

**Inputs**: None.

**Outputs**

- `attachment_kinds` (list): The kinds of attachment
- `count` (number): How many record types
- `fields` (list): The record fields
- `record_types` (list): The record types

**Example output**

```json
{
  "attachment_kinds": [
    {
      "id": "signedCopy",
      "name": "Signed PDF"
    }
  ],
  "count": 1,
  "fields": [
    {
      "id": "counterpartyName",
      "name": "Counterparty Name",
      "type": "string",
      "visible": true
    }
  ],
  "record_types": [
    {
      "id": "mutualNDA",
      "name": "Mutual NDA"
    }
  ]
}
```

### List records

List contracts in the repository, filtered by record type, words or when they last changed. Returns one page.

**Inputs**

- Record type (`record_type`, text): Only records of this type.
- Changed since (`updated_since`, date and time): Only those changed at or after this time.
- Search (`search`, text): Words to look for anywhere in it, as Ironclad's own search does.
- Order (`order`, text): How to sort them. Defaults to newest agreement date first. One of: `lastUpdated:DESC` (Recently changed first), `agreementDate:DESC` (Newest agreement date first (default)), `agreementDate:ASC` (Oldest agreement date first), `name:ASC` (Name, A to Z), `name:DESC` (Name, Z to A).
- Page (`page`, number): Which page of results, from 1. Defaults to the first. At least 1.
- Page size (`page_size`, number): How many per page, 1 to 100. Ironclad's default is 20. From 1 to 100.

**Outputs**

- `count` (number): How many on this page
- `has_more` (true/false): True when there is a next page
- `page` (number): Which page this is, from 1
- `records` (list): The records
- `total` (number): How many match in all

**Example output**

```json
{
  "count": 1,
  "has_more": false,
  "page": 1,
  "records": [
    {
      "attachments": {
        "signedCopy": {
          "filename": "Mutual NDA - Acme LLC.pdf",
          "href": "https://na1.ironcladapp.com/public/api/v1/records/22e2ff72-56a1-4711-a4ca-41328d311e9f/attachments/signedCopy"
        }
      },
      "id": "22e2ff72-56a1-4711-a4ca-41328d311e9f",
      "ironcladId": "IC-1042",
      "lastUpdated": "2026-10-21T09:05:00Z",
      "links": [],
      "name": "Mutual NDA with Acme LLC",
      "properties": {
        "agreementDate": {
          "type": "date",
          "value": "2026-10-21T00:00:00Z"
        },
        "counterpartyName": {
          "type": "string",
          "value": "Acme LLC"
        }
      },
      "type": "mutualNDA",
      "typeDisplayName": "Mutual NDA"
    }
  ],
  "total": 1
}
```

### List signers

List a workflow's signers and whether each has signed. Before the Sign step the list is empty, with a note saying where it is.

**Inputs**

- Workflow (`ironclad_workflow_id`, text, required): The workflow's ID or its Ironclad ID (such as IC-123), from 'List workflows', an earlier step or the end of the workflow's address.

**Outputs**

- `count` (number): How many
- `in_signing` (true/false): False when the workflow is not at the Sign step
- `note` (text): Ironclad's explanation when there is nobody to list
- `signers` (list): The signers
- `workflow_id` (text): The workflow's ID

**Example output**

```json
{
  "count": 1,
  "in_signing": true,
  "note": "",
  "signers": [
    {
      "delegates": [],
      "email": "sam@acme.example",
      "name": "Sam Lee",
      "roleName": "Counterparty Signer",
      "signatureStatus": {
        "status": "sent"
      },
      "status": "sent"
    }
  ],
  "workflow_id": "6013609108b8f070cee94fc1"
}
```

### List workflow documents

List a workflow's documents, saying which are in the signature packet, with the key to download each.

**Inputs**

- Workflow (`ironclad_workflow_id`, text, required): The workflow's ID or its Ironclad ID (such as IC-123), from 'List workflows', an earlier step or the end of the workflow's address.

**Outputs**

- `count` (number): How many
- `documents` (list): The documents
- `workflow_id` (text): The workflow's ID

**Example output**

```json
{
  "count": 1,
  "documents": [
    {
      "download": "/public/api/v1/workflows/6013609108b8f070cee94fc1/document/rJklwCHQ/download",
      "filename": "Mutual NDA - Acme LLC.docx",
      "in_signature_packet": true,
      "key": "rJklwCHQ",
      "lastModified": {
        "timestamp": "2026-10-21T09:05:00.000Z"
      },
      "version": "B1QePArXb",
      "versionNumber": 2
    }
  ],
  "workflow_id": "6013609108b8f070cee94fc1"
}
```

### List workflow templates

List the published workflow templates you can launch, with their IDs.

**Inputs**: None.

**Outputs**

- `count` (number): How many
- `templates` (list): The templates

**Example output**

```json
{
  "count": 1,
  "templates": [
    {
      "field_count": 6,
      "id": "600b296c3e15a234ab88f884",
      "name": "Mutual NDA"
    }
  ]
}
```

### List workflows

List workflows, filtered by status, template, words or when they last changed. Gets one page; to see more, run it again with the next page it gives.

**Inputs**

- Status (`status`, list): Which to include. Defaults to those in progress. One or more of: `active` (In progress), `paused`, `completed`, `cancelled`.
- Workflow template (`template_id`, text): Only workflows launched from this template.
- Changed since (`updated_since`, date and time): Only those changed at or after this time.
- Search (`search`, text): Words to look for anywhere in it, as Ironclad's own search does.
- Page (`page`, number): Which page of results, from 1. Defaults to the first. At least 1.
- Page size (`page_size`, number): How many per page, 1 to 100. Ironclad's default is 20. From 1 to 100.

**Outputs**

- `count` (number): How many on this page
- `has_more` (true/false): True when there is a next page
- `page` (number): Which page this is, from 1
- `total` (number): How many match in all
- `workflows` (list): The workflows

**Example output**

```json
{
  "count": 1,
  "has_more": false,
  "page": 1,
  "total": 1,
  "workflows": [
    {
      "approvals": {
        "state": "in_progress"
      },
      "attributes": {
        "agreementDate": "2026-10-21",
        "counterpartyName": "Acme LLC"
      },
      "created": "2026-10-21T09:00:00.000Z",
      "creator": {
        "displayName": "Jo Bloggs",
        "email": "jo@example.com",
        "id": "63d415e0dd0d828c3a878548"
      },
      "id": "6013609108b8f070cee94fc1",
      "ironcladId": "IC-1042",
      "lastUpdated": "2026-10-21T09:05:00.000Z",
      "recordIds": [],
      "recordType": "mutualNDA",
      "roles": [
        {
          "assignees": [
            {
              "email": "jo@example.com",
              "userId": "63d415e0dd0d828c3a878548",
              "userName": "Jo Bloggs"
            }
          ],
          "displayName": "Legal",
          "id": "legal"
        }
      ],
      "signatures": {
        "state": "not_started"
      },
      "status": "active",
      "step": "Review",
      "template": "600b296c3e15a234ab88f884",
      "title": "Mutual NDA with Acme LLC"
    }
  ]
}
```

### Pause workflow

Pause a workflow in the Review step, posting the reason on its feed.

**Inputs**

- Workflow (`ironclad_workflow_id`, text, required): The workflow's ID or its Ironclad ID (such as IC-123), from 'List workflows', an earlier step or the end of the workflow's address.
- Reason (`reason`, text, required): Why, posted as a comment on the workflow's activity feed.

**Outputs**

- `reason` (text): The reason posted with it
- `status` (text): Its status now
- `workflow_id` (text): The workflow's ID

**Example output**

```json
{
  "reason": "Waiting on the customer's budget sign-off.",
  "status": "paused",
  "workflow_id": "6013609108b8f070cee94fc1"
}
```

### Resume workflow

Resume a paused workflow, posting the reason on its feed.

**Inputs**

- Workflow (`ironclad_workflow_id`, text, required): The workflow's ID or its Ironclad ID (such as IC-123), from 'List workflows', an earlier step or the end of the workflow's address.
- Reason (`reason`, text, required): Why, posted as a comment on the workflow's activity feed.

**Outputs**

- `reason` (text): The reason posted with it
- `status` (text): Its status now
- `workflow_id` (text): The workflow's ID

**Example output**

```json
{
  "reason": "Budget approved.",
  "status": "active",
  "workflow_id": "6013609108b8f070cee94fc1"
}
```

### Update record

Rename a record, or change or clear its fields. Only what is given changes.

**Inputs**

- Record (`record_id`, text, required): The record's ID or its Ironclad ID (such as IC-123), from 'List records' or an earlier step.
- Name (`name`, text): A new name. Leave empty to keep it.
- Fields (`fields`, object): The record's fields and their values. Dates, numbers, yes or no, money (1500 USD) and lengths of time (2 years) are converted for you.
- Fields to clear (`clear_fields`, list): IDs of fields to remove from the record.

**Outputs**

- `record` (object): The record

**Example output**

```json
{
  "record": {
    "attachments": {
      "signedCopy": {
        "filename": "Mutual NDA - Acme LLC.pdf",
        "href": "https://na1.ironcladapp.com/public/api/v1/records/22e2ff72-56a1-4711-a4ca-41328d311e9f/attachments/signedCopy"
      }
    },
    "id": "22e2ff72-56a1-4711-a4ca-41328d311e9f",
    "ironcladId": "IC-1042",
    "lastUpdated": "2026-10-21T09:05:00Z",
    "links": [],
    "name": "Mutual NDA with Acme LLC",
    "properties": {
      "agreementDate": {
        "type": "date",
        "value": "2026-10-21T00:00:00Z"
      },
      "counterpartyName": {
        "type": "string",
        "value": "Acme LLC"
      }
    },
    "type": "mutualNDA",
    "typeDisplayName": "Mutual NDA"
  }
}
```

### Update workflow fields

Change or clear a workflow's answers. Ironclad allows this only while the workflow is in the Review step, and not for documents.

**Inputs**

- Workflow (`ironclad_workflow_id`, text, required): The workflow's ID or its Ironclad ID (such as IC-123), from 'List workflows', an earlier step or the end of the workflow's address.
- Fields (`fields`, object): The answers to change. Fields left empty keep their answers.
- Fields to clear (`clear_fields`, list): IDs of fields to empty. A required field can't be cleared.
- Comment (`comment`, text): Why, shown in the workflow's activity feed.

**Outputs**

- `workflow` (object): The workflow

**Example output**

```json
{
  "workflow": {
    "approvals": {
      "state": "in_progress"
    },
    "attributes": {
      "agreementDate": "2026-10-21",
      "counterpartyName": "Acme LLC"
    },
    "created": "2026-10-21T09:00:00.000Z",
    "creator": {
      "displayName": "Jo Bloggs",
      "email": "jo@example.com",
      "id": "63d415e0dd0d828c3a878548"
    },
    "id": "6013609108b8f070cee94fc1",
    "ironcladId": "IC-1042",
    "lastUpdated": "2026-10-21T09:05:00.000Z",
    "recordIds": [],
    "recordType": "mutualNDA",
    "roles": [
      {
        "assignees": [
          {
            "email": "jo@example.com",
            "userId": "63d415e0dd0d828c3a878548",
            "userName": "Jo Bloggs"
          }
        ],
        "displayName": "Legal",
        "id": "legal"
      }
    ],
    "signatures": {
      "state": "not_started"
    },
    "status": "active",
    "step": "Review",
    "template": "600b296c3e15a234ab88f884",
    "title": "Mutual NDA with Acme LLC"
  }
}
```
