Ironclad
App · 24 actions
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.
Actions
| Action | What it does |
|---|---|
| Add comment | Post a comment on a workflow's activity feed as the connection's user. |
| Add record attachment | Attach a file to a record, such as its signed copy. |
| Approve workflow | Approve a workflow for an approver role, or withdraw that approval. |
| Cancel workflow | Cancel a workflow, posting the reason on its activity feed. |
| Create record | Add a contract record to the repository, with its type, name and fields. |
| Delete record | Delete a record from the repository, with its attachments. |
| Download record attachment | Download one of a record's files, such as its signed copy, and save it in Lodol for a later step. |
| Download workflow document | Download a workflow document's latest version and save it in Lodol, to attach or send in a later step. |
| 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'. |
| Get record | Get one record with its fields, attachments and linked records. |
| Get workflow | Get one workflow: its answers, step, status, roles, approval and signing state, and each field's type. |
| Launch workflow | Launch a workflow from a template, answering its launch form. |
| 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. |
| List comments | List the comments on a workflow's activity feed, one page at a time. |
| List record types and fields | List the repository's record types, record fields (with each one's ID and type) and kinds of attachment. |
| List records | List contracts in the repository, filtered by record type, words or when they last changed. |
| List signers | List a workflow's signers and whether each has signed. |
| List workflow documents | List a workflow's documents, saying which are in the signature packet, with the key to download each. |
| List workflow templates | List the published workflow templates you can launch, with their IDs. |
| List workflows | List workflows, filtered by status, template, words or when they last changed. |
| Pause workflow | Pause a workflow in the Review step, posting the reason on its feed. |
| Resume workflow | Resume a paused workflow, posting the reason on its feed. |
| Update record | Rename a record, or change or clear its fields. |
| Update workflow fields | Change or clear a workflow's answers. |
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_idtextRequired - 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
messagetextRequired - What to say. Mention someone with <@jo@example.com>.
- Reply to
reply_to_comment_idtext - The ID of a comment to reply to, from 'List comments'.
- Add mentioned people to the workflow
add_mentioned_peopletrue/false - Needed when you mention someone who is not yet on the workflow.
Outputs
commentobject- A comment
Example output
{
"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_idtextRequired - The record's ID or its Ironclad ID (such as IC-123), from 'List records' or an earlier step.
- Attachment kind
attachment_keytextRequired - 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
filetextRequired - Upload a file, use one from an earlier step, or give a public link to one (PDF, Word, Excel, images and more).
- File name
filenametext - The name to save it under, with its extension such as .pdf. Defaults to the file's own name.
Outputs
attachment_keytext- The attachment kind it was saved under
filenametext- The file's name
record_idtext- The record's ID
size_bytesnumber- The file's size in bytes
Example output
{
"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_idtextRequired - 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_idtextRequired - The approval to give, such as Legal. Pick one, or give its role ID from 'List approvals'.
- Decision
decisiontext - Approve, or withdraw an approval given earlier.One of:
approved(Approve),pending(Withdraw approval). Default:approved. - Approve as
approver_emailtext - The email of the user assigned to the role. Leave empty to approve as the connection's user.
Outputs
approver_emailtext- Who it was given as
role_idtext- The approver role
statustext- approved, or pending once withdrawn
workflow_idtext- The workflow's ID
Example output
{
"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_idtextRequired - 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
reasontextRequired - Why, posted as a comment on the workflow's activity feed.
Outputs
reasontext- The reason posted with it
statustext- Its status now
workflow_idtext- The workflow's ID
Example output
{
"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_typetextRequired - The kind of contract. Pick one, or give its ID.
- Name
nametextRequired - The record's name, as the repository shows it.
- Fields
fieldsobject - 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
recordobject- The record
Example output
{
"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_idtextRequired - The record's ID or its Ironclad ID (such as IC-123), from 'List records' or an earlier step.
Outputs
deletedtrue/false- Always true once deleted
record_idtext- The record deleted
Example output
{
"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_idtextRequired - The record's ID or its Ironclad ID (such as IC-123), from 'List records' or an earlier step.
- Attachment kind
attachment_keytextRequired - 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_keytext- The attachment kind
content_typetext- The file's type
document_reftext- The saved file, to use in a later step
filenametext- The file's name
record_idtext- The record's ID
size_bytesnumber- The file's size in bytes
urltext- A link to open the saved file in Lodol
Example output
{
"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_idtextRequired - 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_keytextRequired - The document's key, from 'List workflow documents'.
Outputs
content_typetext- The file's type
document_keytext- The document's key
document_reftext- The saved file, to use in a later step
filenametext- The file's name
size_bytesnumber- The file's size in bytes
urltext- A link to open the saved file in Lodol
workflow_idtext- The workflow's ID
Example output
{
"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_idtextRequired - The published workflow template. Pick one, or give its ID.
Outputs
countnumber- How many fields
example_fieldsobject- An example answer for each required field, by field ID, in the form 'Launch workflow' takes
fieldslist- The form's fields
nametext- The template's name
required_fieldslist- IDs of the fields that must be answered
template_idtext- The template's ID
Example output
{
"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_idtextRequired - The record's ID or its Ironclad ID (such as IC-123), from 'List records' or an earlier step.
Outputs
recordobject- The record
Example output
{
"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_idtextRequired - 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
workflowobject- The workflow
Example output
{
"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_idtextRequired - The published workflow template. Pick one, or give its ID.
- Fields
fieldsobject - 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_answerstrue/false - Fill fields left empty with the defaults the template sets. On unless turned off.Default:
true.
Outputs
workflowobject- The workflow
Example output
{
"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_idtextRequired - 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_approvedtrue/false- True once every approval is given
approvalslist- Every approval triggered so far
awaitinglist- The approvals whose turn it is now
countnumber- How many
titletext- The workflow's title
workflow_idtext- The workflow's ID
Example output
{
"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_idtextRequired - 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
pagenumber - Which page of results, from 1. Defaults to the first.At least 1.
- Page size
page_sizenumber - How many per page, 1 to 100. Ironclad's default is 20.From 1 to 100.
Outputs
commentslist- The comments
countnumber- How many on this page
has_moretrue/false- True when there is a next page
pagenumber- Which page this is, from 1
totalnumber- How many match in all
Example output
{
"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_kindslist- The kinds of attachment
countnumber- How many record types
fieldslist- The record fields
record_typeslist- The record types
Example output
{
"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_typetext - Only records of this type.
- Changed since
updated_sincedate and time - Only those changed at or after this time.
- Search
searchtext - Words to look for anywhere in it, as Ironclad's own search does.
- Order
ordertext - 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
pagenumber - Which page of results, from 1. Defaults to the first.At least 1.
- Page size
page_sizenumber - How many per page, 1 to 100. Ironclad's default is 20.From 1 to 100.
Outputs
countnumber- How many on this page
has_moretrue/false- True when there is a next page
pagenumber- Which page this is, from 1
recordslist- The records
totalnumber- How many match in all
Example output
{
"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_idtextRequired - 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
countnumber- How many
in_signingtrue/false- False when the workflow is not at the Sign step
notetext- Ironclad's explanation when there is nobody to list
signerslist- The signers
workflow_idtext- The workflow's ID
Example output
{
"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_idtextRequired - 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
countnumber- How many
documentslist- The documents
workflow_idtext- The workflow's ID
Example output
{
"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
countnumber- How many
templateslist- The templates
Example output
{
"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
statuslist - Which to include. Defaults to those in progress.One or more of:
active(In progress),paused,completed,cancelled. - Workflow template
template_idtext - Only workflows launched from this template.
- Changed since
updated_sincedate and time - Only those changed at or after this time.
- Search
searchtext - Words to look for anywhere in it, as Ironclad's own search does.
- Page
pagenumber - Which page of results, from 1. Defaults to the first.At least 1.
- Page size
page_sizenumber - How many per page, 1 to 100. Ironclad's default is 20.From 1 to 100.
Outputs
countnumber- How many on this page
has_moretrue/false- True when there is a next page
pagenumber- Which page this is, from 1
totalnumber- How many match in all
workflowslist- The workflows
Example output
{
"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_idtextRequired - 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
reasontextRequired - Why, posted as a comment on the workflow's activity feed.
Outputs
reasontext- The reason posted with it
statustext- Its status now
workflow_idtext- The workflow's ID
Example output
{
"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_idtextRequired - 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
reasontextRequired - Why, posted as a comment on the workflow's activity feed.
Outputs
reasontext- The reason posted with it
statustext- Its status now
workflow_idtext- The workflow's ID
Example output
{
"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_idtextRequired - The record's ID or its Ironclad ID (such as IC-123), from 'List records' or an earlier step.
- Name
nametext - A new name. Leave empty to keep it.
- Fields
fieldsobject - 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_fieldslist - IDs of fields to remove from the record.
Outputs
recordobject- The record
Example output
{
"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_idtextRequired - 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
fieldsobject - The answers to change. Fields left empty keep their answers.
- Fields to clear
clear_fieldslist - IDs of fields to empty. A required field can't be cleared.
- Comment
commenttext - Why, shown in the workflow's activity feed.
Outputs
workflowobject- The workflow
Example output
{
"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"
}
}