Activate Record
Activate a record and set its effective date, term, termination notice, expiration, and renewal behavior. Use this only for activation; use the other record lifecycle actions for later lifecycle changes.
ActionTry it
Integrate Ironclad
with your AI CRM
Ironclad is a contract lifecycle management platform for launching and tracking contract workflows, approvals and signatures, and for managing the repository of contract records, entities and obligations.
Explore Triggers and Actions
Cancel Record Auto-Renewal
Cancel auto-renewal for a record. This lifecycle intent takes no renewal properties; use IRONCLAD_EDIT_RECORD_RENEWAL to change renewal settings.
ActionTry it
Cancel Workflow
Cancel a workflow, recording a comment that explains why. This cannot be undone: no operation reopens a cancelled workflow. To stop one for a while use IRONCLAD_PAUSE_WORKFLOW; to recall only the signature request use IRONCLAD_CANCEL_WORKFLOW_SIGNATURE_REQUEST.
ActionTry it
Cancel Workflow Signature Request
Cancel the signature request (the signature packet sent to the signers) that is out for signature on a workflow, with a reason. This cannot be undone; the request has to be sent again with IRONCLAD_SEND_WORKFLOW_SIGNATURE_REQUEST. Cancellation may email signers; mute_cancellation_notifications suppresses those emails only for Ironclad Signature and Adobe Sign. To cancel the whole workflow use IRONCLAD_CANCEL_WORKFLOW; to remove a send that is only scheduled use IRONCLAD_DELETE_SCHEDULED_WORKFLOW_SIGNATURE_REQUEST.
ActionTry it
Create Data Export
Start a data export job for workflow activity or the audit log, optionally limited to a date range; it does not wait for the file and returns a pollable job_id. job_status may be omitted, which means the current state is unknown, not that the job_id is unusable. Poll IRONCLAD_GET_DATA_EXPORT_STATUS with that job_id until job_status is done (Ironclad documents no polling interval), then fetch the file with IRONCLAD_DOWNLOAD_DATA_EXPORT within 14 days of creating the export. Requires Ironclad's paid Security & Data Pro add-on. For a spreadsheet of records use IRONCLAD_EXPORT_RECORDS_XLSX. Needs the public.export.createReports scope, a paid add-on not requested by default: add it to the auth config.
ActionTry it
Create Embedded Workflow Signature Recipient URL
Create a signing link for one signer that is allowed to load inside a frame on the given parent site. It works only with Ironclad Signature as the signature provider, and the workflow must be on the Sign step. For a plain link, or one for a view-only recipient, use IRONCLAD_CREATE_WORKFLOW_SIGNATURE_RECIPIENT_URL. The returned URL is a sensitive bearer capability: anyone with it may view or sign as the recipient. Do not log it, persist it unnecessarily, put it in comments, or share it outside the intended recipient.
ActionTry it
Create Entity
Create an entity (a counterparty or other party that contracts refer to) with a name and, optionally, a relationship type, status, parent and properties. Get the relationship type key from IRONCLAD_LIST_ENTITY_RELATIONSHIP_TYPES; property ids are defined per company and can only be read from an existing entity with IRONCLAD_GET_ENTITY. Property values are wrapped as {type, value}. To change an existing entity use IRONCLAD_UPDATE_ENTITY.
ActionTry it
Create Obligation
Create a standalone obligation on a contract record. To record a triggered occurrence of an existing obligation, use IRONCLAD_CREATE_OBLIGATION_OCCURRENCE instead. The tenant-defined obligation type key must already be known and cannot be discovered by this toolkit because the documented public.obligations.readTypes scope is absent from OAuth's scope catalog. Property ids belong to that type and no tool lists them, so read them from an existing obligation with IRONCLAD_GET_OBLIGATION, and wrap each value as {type, value}. Recurrence cadence cannot be set through the API. Needs the public.obligations.createObligations scope, a paid add-on not requested by default: add it to the auth config.
ActionTry it
Create Obligation Occurrence
Record a new triggered occurrence of an existing source obligation. Triggered obligations must be enabled for the account. The occurrence requires its source id, status, due date, and assignee. It inherits the source obligation's contract and type when parent_id and obligation_type_key are omitted. Property ids belong to that type and no tool lists them, so read them from an existing obligation with IRONCLAD_GET_OBLIGATION and wrap each value as {type, value}. Needs the public.obligations.createObligations scope, a paid add-on not requested by default: add it to the auth config.
ActionTry it
Create Record
Create a contract record in the repository with a record type, a name and metadata properties. Call IRONCLAD_GET_RECORDS_SCHEMA first for the valid record type keys and the property ids and types, which each company defines; every property value is wrapped as {type, value}. This stores a record directly, without a workflow: to start a contract process use IRONCLAD_LAUNCH_WORKFLOW, and to change an existing record use IRONCLAD_UPDATE_RECORD. Ironclad may return either the created record or only {success: true}; the acknowledgement does not contain a record id, so use IRONCLAD_LIST_RECORDS to find the new record when its id is needed.
ActionTry it
Create Smart Import Record
Upload a contract file and use Smart Import to create a record and predict its properties. Omit import_id to start a new import; provide it to add the record to an existing import. With an existing import and no type parameter, record_type imported is sent; new record type fields are available only when starting a new import. It may return record_id, import_id and remaining credits. A response without record_id fails confirmation instead of reporting successful execution. If import_id was returned, poll it and verify the result with IRONCLAD_LIST_RECORDS; if no import_id was returned, check IRONCLAD_LIST_RECORDS before retrying. Poll IRONCLAD_GET_SMART_IMPORT_PREDICTIONS because predictions take time. Smart Import is separately priced. Use IRONCLAD_CREATE_RECORD instead to create a record from known values. Needs the public.records.createSmartImportRecords scope, a paid add-on not requested by default: add it to the auth config.
ActionTry it
Create Workflow Comment
Post a comment to a workflow's activity feed as the connected user, optionally as a reply to another comment and with @-mentions. When add_users_to_workflow is true, mentioned users who are not already workflow participants are added to the workflow. Returns the created comment. Read existing comments and their ids with IRONCLAD_LIST_WORKFLOW_COMMENTS.
ActionTry it
Create Workflow Signature Recipient URL
Create a link that a signer, or a view-only recipient, can open to reach the workflow's signature request. It works only with Ironclad Signature as the signature provider, and the workflow must be on the Sign step. For a signing link that can be embedded in a frame on another site use IRONCLAD_CREATE_EMBEDDED_WORKFLOW_SIGNATURE_RECIPIENT_URL. The returned URL is a sensitive bearer capability: anyone with it may view or sign as the recipient. Do not log it, persist it unnecessarily, put it in comments, or share it outside the intended recipient.
ActionTry it
Delete Entity
Delete an entity. No restore operation is documented, so treat this as permanent; to keep the entity but stop using it, set its status to INACTIVE with IRONCLAD_UPDATE_ENTITY instead.
ActionTry it
Delete Obligation
Delete an obligation. A triggered occurrence is deleted directly. A recurring occurrence cannot be deleted on its own: Ironclad answers 409 with the source obligation's id in sourceObligationId, and that source obligation is the one to delete. No restore operation is documented, so treat the deletion as permanent. Needs the public.obligations.deleteObligations scope, a paid add-on not requested by default: add it to the auth config.
ActionTry it
Delete Record
Delete a contract record from the repository. No restore operation is documented, so treat it as permanent. To remove only a file from the record use IRONCLAD_DELETE_RECORD_ATTACHMENT.
ActionTry it
Delete Record Attachment
Remove one file from a contract record by its attachment key; the record itself stays. Attachment keys are listed under attachments on IRONCLAD_GET_RECORD. No restore operation is documented, so treat it as permanent. Do this before IRONCLAD_UPLOAD_RECORD_ATTACHMENT when replacing a file under the same key. To delete the whole record use IRONCLAD_DELETE_RECORD.
ActionTry it
Delete Scheduled Workflow Signature Request
Remove the scheduled send from a workflow, so its signature request (the signature packet for the signers) is no longer sent at the scheduled time. The workflow must be in the Sign step and not yet out for signature. Schedule again with IRONCLAD_SCHEDULE_WORKFLOW_SIGNATURE_REQUEST. To recall a request that was already sent use IRONCLAD_CANCEL_WORKFLOW_SIGNATURE_REQUEST.
ActionTry it
Delete Workflow Signer
Remove a signer from a workflow's signature packet. If the packet is out collecting signatures this cancels it, and it has to be sent again with IRONCLAD_SEND_WORKFLOW_SIGNATURE_REQUEST. That cancellation may email signers; mute_cancellation_notifications suppresses those emails only for Ironclad Signature and Adobe Sign. To replace the signer instead use IRONCLAD_UPDATE_WORKFLOW_SIGNER.
ActionTry it
Download Data Export
Download the file of a finished data export job: CSV, or JSON Lines if the job was created with export_format JSON. It works only after IRONCLAD_GET_DATA_EXPORT_STATUS reports done, and only within 14 days of the job's creation. Start the job with IRONCLAD_CREATE_DATA_EXPORT and call IRONCLAD_GET_DATA_EXPORT_STATUS again until job_status is done; the docs give no polling interval. Data export is a paid Ironclad add-on. Needs the public.export.readReports scope, a paid add-on not requested by default: add it to the auth config.
ActionTry it
Download Record Attachment
Download one file attached to a record by its attachment key; signedCopy is the key of the signed copy. The record's attachment keys are listed under attachments on IRONCLAD_GET_RECORD. For a contract that came from a workflow, the record id is in record_ids on IRONCLAD_GET_WORKFLOW. For documents of a workflow still in progress use IRONCLAD_DOWNLOAD_WORKFLOW_DOCUMENT.
ActionTry it
Download Workflow Document
Download one document of a workflow by its document key: a draft (usually DOCX) or the signed PDF. Get the key from IRONCLAD_LIST_WORKFLOW_DOCUMENTS, or from IRONCLAD_GET_WORKFLOW where it is the path segment before /download in a file attribute's download link (attributes.draft, attributes.signed). Once the workflow has created its record, the signed copy is also stored there: take a record id from record_ids on IRONCLAD_GET_WORKFLOW and use IRONCLAD_DOWNLOAD_RECORD_ATTACHMENT.
ActionTry it
Download Workflow Email Attachment
Download one file attached to an email thread of a workflow. Get the email thread id from IRONCLAD_LIST_WORKFLOW_EMAIL_THREADS; the attachment id is the last path segment of that attachment's download link there. For the workflow's own documents use IRONCLAD_DOWNLOAD_WORKFLOW_DOCUMENT.
ActionTry it
Edit Record Renewal
Edit a record's renewal type, term, opt-out timing, remaining renewal count, initial term, and expiration settings.
ActionTry it
Export Data
Create an Ironclad workflow-activity or audit-log data export job, poll its status with a bounded configurable wait, then download and return the completed CSV or JSON Lines file. A failed job or polling timeout fails deterministically without attempting the download. Requires Ironclad's paid Security & Data Pro add-on and both public.export.createReports and public.export.readReports scopes.
ActionTry it
Export Records XLSX
Download an XLSX spreadsheet of records for the record types and property columns you name. Both lists are required and their values are defined per company: get the record type keys and property ids from IRONCLAD_GET_RECORDS_SCHEMA. Limited to 10 calls per minute. For workflow activity or audit-log data use IRONCLAD_CREATE_DATA_EXPORT; to read records as data use IRONCLAD_LIST_RECORDS.
ActionTry it
Extend Record
Extend a record, optionally setting the renewal term length.
ActionTry it
Get Data Export Status
Check a data export job started with IRONCLAD_CREATE_DATA_EXPORT. job_status is pending, running, done or failed: call again while it is pending or running (Ironclad documents no polling interval), and when it is done fetch the file with IRONCLAD_DOWNLOAD_DATA_EXPORT, which works for 14 days after the export was created. If job_status is absent, the provider response does not confirm the job's state: do not report completion or success, and call this read tool again later. No tool retries a failed job: start a new one with IRONCLAD_CREATE_DATA_EXPORT. It does not apply to IRONCLAD_EXPORT_RECORDS_XLSX, which returns its file in the same call. Requires Ironclad's paid Security & Data Pro add-on. Needs the public.export.readReports scope, a paid add-on not requested by default: add it to the auth config.
ActionTry it
Get Entity
Get one entity by id or Ironclad id: its name, status, relationship type ids, parent and properties (each as {type, value}). Its properties show the property ids the company uses, which no other tool lists, so read an entity before IRONCLAD_CREATE_ENTITY or IRONCLAD_UPDATE_ENTITY; relationship type ids are explained by IRONCLAD_LIST_ENTITY_RELATIONSHIP_TYPES.
ActionTry it
Get Obligation
Get one obligation by id or Ironclad id: its name, parent contract, status, due date, assignee and properties (each as {type, value}), and whether it is a source obligation or an occurrence; a source obligation's occurrences are listed by IRONCLAD_LIST_OBLIGATION_INSTANCES. Its properties show property ids of its obligation type; no tool lists those ids. Needs the public.obligations.readObligations scope, a paid add-on not requested by default: add it to the auth config.
ActionTry it
Get Record
Get one contract record by id or Ironclad id: its type, name, properties (each as {type, value}), attachments, links, parent and children, and contract status. Property ids are defined per company; their display names and types are in IRONCLAD_GET_RECORDS_SCHEMA. The attachment keys it returns are what IRONCLAD_DOWNLOAD_RECORD_ATTACHMENT takes (signedCopy is the signed copy). For a contract that came from a workflow, the record id is in record_ids on IRONCLAD_GET_WORKFLOW; for a contract still in progress use IRONCLAD_GET_WORKFLOW itself.
ActionTry it
Get Records Schema
Get the record schema of the company's repository: the record type keys, every property id with its display name and type, and the attachment keys. Call it before creating, updating, filtering or exporting records, because all of these are defined per company; IRONCLAD_LIST_RECORDS shows real values. It covers the whole repository, not one record type. Workflow launch forms are described by IRONCLAD_GET_WORKFLOW_SCHEMA instead.
ActionTry it
Get Smart Import Predictions
Check whether Smart Import has finished predicting properties, for one record (record_id) or for every record of an import (import_id); one of the two is required. Use the ids returned by IRONCLAD_CREATE_SMART_IMPORT_RECORD (including when import_id adds a record to an existing import), and call again while a status is pending (Ironclad documents no polling interval). It returns status only: read the predicted values with IRONCLAD_GET_RECORD. Smart Import is a separately priced feature. Needs the public.records.readSmartImportRecords scope, a paid add-on not requested by default: add it to the auth config.
ActionTry it
Get Workflow
Get one workflow by id or Ironclad id: its step, status, roles, approvals, signatures, attribute values and the schema that types each attribute. Read it before IRONCLAD_UPDATE_WORKFLOW_ATTRIBUTES to learn the attribute ids and current values, and to find document keys for IRONCLAD_DOWNLOAD_WORKFLOW_DOCUMENT. The launch-form subset of the attributes is described by IRONCLAD_GET_WORKFLOW_SCHEMA. record_ids holds the ids of the records the workflow created: pass one to IRONCLAD_GET_RECORD, or to IRONCLAD_DOWNLOAD_RECORD_ATTACHMENT with the key signedCopy for the archived signed copy. It is empty while the workflow has created no record.
ActionTry it
Get Workflow Comment
Get one comment of a workflow by its comment id, with author, time, mentions, the comment it replies to and reactions. To browse comments use IRONCLAD_LIST_WORKFLOW_COMMENTS.
ActionTry it
Get Workflow Email Thread
Get one email thread of a workflow by its email thread id. Ironclad returns it as one inbound or outbound email with author, subject, body and attachments. Find the ids with IRONCLAD_LIST_WORKFLOW_EMAIL_THREADS. Activity-feed comments are read with IRONCLAD_GET_WORKFLOW_COMMENT instead.
ActionTry it
Get Workflow Launch Status
Check a workflow launch started with IRONCLAD_LAUNCH_WORKFLOW using execution_mode async. status is in_progress, success (the launched workflow is under workflow) or failed (the cause is under error; when error.metadata.workflowId is present a workflow was created anyway, so read it with IRONCLAD_GET_WORKFLOW instead of launching again, which would create a second one). While it is in_progress call again, waiting at least 2 seconds between calls, and do not start another launch. The attribute keys in the returned workflow are the template's ids from IRONCLAD_GET_WORKFLOW_SCHEMA. To read a workflow that already exists use IRONCLAD_GET_WORKFLOW.
ActionTry it
Get Workflow Schema
Get the launch-form schema of one workflow template: every attribute id with its type, display name, whether it is required (always, never or conditional) and its dropdown options. Call it before IRONCLAD_LAUNCH_WORKFLOW to know which attributes to send and in what shape. IRONCLAD_LIST_WORKFLOW_SCHEMAS returns the template ids, with the same schema for every template. For record properties use IRONCLAD_GET_RECORDS_SCHEMA.
ActionTry it
Get Workflow Sign Status
Get the signing state of a workflow that is in the Sign step: signers and their status, routing order, the signature provider, whether a signed upload is required and any scheduled send. It fails when the workflow is not in the Sign step, so an error after the signers have signed may only mean the workflow has left that step: check step on IRONCLAD_GET_WORKFLOW before treating it as a failed signature.
ActionTry it
Launch Workflow
Launch a workflow from a template. execution_mode wait (default) returns the workflow; async returns a job id. Poll an async job with IRONCLAD_GET_WORKFLOW_LAUNCH_STATUS no faster than every 2 seconds until success or failure, and do not relaunch while it is in_progress. Discover template and attribute ids with IRONCLAD_LIST_WORKFLOW_SCHEMAS or IRONCLAD_GET_WORKFLOW_SCHEMA. A wait-mode timeout does not prove failure: check IRONCLAD_LIST_WORKFLOWS before retrying. A 409 can mean a workflow was already created; list recent workflows for this template and use IRONCLAD_GET_WORKFLOW instead of creating a duplicate. Wait mode accepts direct uploads through files; async mode accepts file attributes only as URLs. Workflow writes are limited to 40 per minute per company.
ActionTry it
Launch Workflow From Attribute Source
Launch from an existing Coupa or Salesforce workflow sync mapping. The source id and object must already be known; no tool discovers them or describes the body. HTTP 202 means missing or invalid values (MISSING_PARAM/INVALID_PARAM) and no launch; error details are withheld, so correct the request or finish manually in the Ironclad UI. A free-form 200 returns outcome workflow_created only with a nonblank workflow id, conflict for a recognized conflict, and unknown otherwise; conflict or unknown does not confirm creation. A 409 can mean a workflow was created but did not finish; check recent workflows with IRONCLAD_LIST_WORKFLOWS before retrying. For explicit template values use IRONCLAD_LAUNCH_WORKFLOW; read a result with IRONCLAD_GET_WORKFLOW.
ActionTry it
List Entities
List the entities (counterparties and other parties) of the company, one page per call, optionally narrowed by free-text search or a formula and sorted. Each entity's properties come back as {type, value} under property ids the company defines. Relationship type ids for the formula come from IRONCLAD_LIST_ENTITY_RELATIONSHIP_TYPES and property ids from IRONCLAD_GET_ENTITY. Set result_format=ids_only to return only ids, with the IDs endpoint's larger page limit.
ActionTry it
List Entity Relationship Types
List the entity relationship types the company has defined, such as customer or vendor, all in one call. Each has an id, which entity filters use, and a name, which Ironclad's examples pass as relationship_type_key to IRONCLAD_CREATE_ENTITY and IRONCLAD_UPDATE_ENTITY. It does not list entity property ids: read those from an existing entity with IRONCLAD_GET_ENTITY.
ActionTry it
List Obligation Instances
List the instances (occurrences) of one source obligation, by id or Ironclad id, one page per call, ordered by due date with undated instances last; every item has obligation_type OCCURRENCE. Recurring occurrences are generated by Ironclad; triggered ones are recorded with IRONCLAD_CREATE_OBLIGATION_OCCURRENCE. Ironclad requires triggered obligations to be enabled for the account. IRONCLAD_LIST_OBLIGATIONS with include=occurrences shows only the first 5 per source obligation; the spec uses instances and occurrences as one and the same. Needs the public.obligations.readObligations scope, a paid add-on not requested by default: add it to the auth config.
ActionTry it
List Obligations
List the source obligations of the company, one page per call, optionally narrowed by free-text search or a formula and sorted. Set include to occurrences to add each source obligation's first 5 occurrences and its occurrence_count; IRONCLAD_LIST_OBLIGATION_INSTANCES pages through all instances (occurrences) of one source obligation. Property ids used in filter are defined per company: read them from the properties of an obligation, here or with IRONCLAD_GET_OBLIGATION. Needs the public.obligations.readObligations scope, a paid add-on not requested by default: add it to the auth config.
ActionTry it
List Records
List the contract records in the repository, one page per call, optionally filtered by record type, update time, free-text search or a property formula, and sorted. Record type keys and property ids are defined per company: get them from IRONCLAD_GET_RECORDS_SCHEMA. Set result_format=ids_only when only ids are needed, and use IRONCLAD_LIST_WORKFLOWS for contracts still in progress.
ActionTry it
List Workflow Approval Requests
List the approval requests that have taken place on a workflow, one page per call: who was asked, when, the outcome and how long it took. It is a history; for the current approval status per role, and the role ids, use IRONCLAD_LIST_WORKFLOW_APPROVALS.
ActionTry it
List Workflow Approvals
Get the current approvals of a workflow in one call (not paged): its approval groups with their order and each reviewer's status, and the workflow's roles with their ids, display names and assignees. Only approvals that have been triggered appear. Use it to find what is waiting for approval and the role_id to approve with IRONCLAD_UPDATE_WORKFLOW_APPROVAL; the docs do not say which field holds it, and role ids appear as role on each reviewer and as id on each role. For the timeline of past approval requests use IRONCLAD_LIST_WORKFLOW_APPROVAL_REQUESTS.
ActionTry it
List Workflow Comments
List the comments in a workflow's activity feed, one page per call, with author, time, mentions, replies and reactions. Use the comment ids to reply with IRONCLAD_CREATE_WORKFLOW_COMMENT. Emails are listed separately by IRONCLAD_LIST_WORKFLOW_EMAIL_THREADS.
ActionTry it
List Workflow Documents
List a workflow's documents in two groups, those in the signature packet and those left out of it, each with its document key, filename and version. All documents are returned in one call. Use the keys with IRONCLAD_DOWNLOAD_WORKFLOW_DOCUMENT and IRONCLAD_UPDATE_WORKFLOW_SIGNATURE_PACKET. The signed copy, once there is one, is the file under attributes.signed on IRONCLAD_GET_WORKFLOW. Files stored on a record are under attachments on IRONCLAD_GET_RECORD.
ActionTry it
List Workflow Email Threads
List the email threads of a workflow, one page per call. Ironclad returns each item as one inbound or outbound email with sender, subject, body and attachments, and for outbound emails the recipients. Use an email thread id with IRONCLAD_GET_WORKFLOW_EMAIL_THREAD. To download an inbound attachment pass the email thread id and the attachment id, which is the last path segment of the attachment's download link, to IRONCLAD_DOWNLOAD_WORKFLOW_EMAIL_ATTACHMENT. Activity-feed comments are listed by IRONCLAD_LIST_WORKFLOW_COMMENTS.
ActionTry it
List Workflow Participants
List the users who participate in a workflow (user id and email), one page per call, optionally narrowed to one email. Use it to get user ids for IRONCLAD_UPDATE_WORKFLOW_SIGNER or to check whether a user must be added before being @-mentioned in a comment.
ActionTry it
List Workflow Role Eligible Assignees
List the users who may be assigned to one role of a workflow, one page per call, plus the role's default assignee where Ironclad returns one. role_name is the role's display name from roles on IRONCLAD_GET_WORKFLOW or IRONCLAD_LIST_WORKFLOW_APPROVALS. Call it before IRONCLAD_UPDATE_WORKFLOW_ROLE_ASSIGNMENT to pick a valid user_id.
ActionTry it
List Workflow Schemas
List the workflow templates that can be launched, with their launch-form schemas: each entry has the template id, name, the same launch-form schema IRONCLAD_GET_WORKFLOW_SCHEMA returns for one template (attribute ids, types, required, options) and what the connected user may do with it (permissions). Call it first to find the template_id for IRONCLAD_LAUNCH_WORKFLOW; set execution_mode to async for an asynchronous launch. These are workflow launch forms: record properties are described by IRONCLAD_GET_RECORDS_SCHEMA.
ActionTry it
List Workflow Signers
List the signers of a workflow with name, email, role name, signature status and delegates. Use it to see who has signed and to get the role names that the signer, reminder and recipient-link tools take as signer_role_name. Ironclad documents an INVALID_STATE error when the workflow is not at the Sign step, so an error after the signers have signed may only mean the workflow has left that step: check step on IRONCLAD_GET_WORKFLOW before treating it as a failed signature. For routing, provider and scheduled-send details use IRONCLAD_GET_WORKFLOW_SIGN_STATUS.
ActionTry it
List Workflow Turn History
List the turn history of a workflow, one page per call: each turn names the party that held the workflow, the user, the location and the start and end times. Use it to see whose turn the workflow has been on and for how long.
ActionTry it
List Workflows
List the workflows the connected user can see, one page per call, optionally filtered by status, template, update time, free-text search or an attribute formula. Only active workflows are returned unless status is set. Attribute ids used in filter are defined per company: get them from IRONCLAD_GET_WORKFLOW_SCHEMA (launch-form attributes of one template) or from the attributes of a workflow on IRONCLAD_GET_WORKFLOW. Set result_format=ids_only when only ids are needed, and use IRONCLAD_LIST_RECORDS for completed contracts stored in the repository.
ActionTry it
Pause Workflow
Pause an active workflow that is in the Review step, recording a comment that explains why; Ironclad documents that only active workflows in the Review step can be paused. Undo it with IRONCLAD_RESUME_WORKFLOW. To end the workflow for good use IRONCLAD_CANCEL_WORKFLOW.
ActionTry it
Refresh Workflow From Attribute Source
Only for an existing attribute source configuration, such as a Coupa or Salesforce workflow sync mapping: refresh a workflow from it. It is the counterpart of IRONCLAD_LAUNCH_WORKFLOW_FROM_ATTRIBUTE_SOURCE. Use it only when the attribute source id and the source object are already known: nothing in this toolkit lists sources or describes the body, and the response does not name the workflow (read it afterwards with IRONCLAD_GET_WORKFLOW). To change single attributes yourself use IRONCLAD_UPDATE_WORKFLOW_ATTRIBUTES.
ActionTry it
Remind Workflow Signer
Email a signer a reminder that their signature is needed. The email cannot be unsent. It works only after the packet has been sent for signature, and Ironclad allows one reminder per hour; with Adobe Sign it reminds every signer who has not signed.
ActionTry it
Replace Record
Replace a record with a new type, name and complete set of properties. Ironclad documents this as supplying the whole new state, so treat any property you leave out as removed: read the record with IRONCLAD_GET_RECORD first and resend what should stay. Property ids and types are defined per company: get them from IRONCLAD_GET_RECORDS_SCHEMA, and wrap each value as {type, value}. To change only some fields use IRONCLAD_UPDATE_RECORD instead.
ActionTry it
Resume Workflow
Resume a workflow that was paused with IRONCLAD_PAUSE_WORKFLOW, recording a comment. Only paused workflows in the Review step can be resumed, so it does not reopen a cancelled workflow. Pause it again with IRONCLAD_PAUSE_WORKFLOW.
ActionTry it
Revert Workflow To Review
Move a workflow from the Sign step back to the Review step. Only workflows built in Workflow Designer that are in the Sign step can be reverted: check is_revertible_to_review on IRONCLAD_GET_WORKFLOW first. This cannot be undone: no operation reverses the revert, and the workflow has to go through review and signing again.
ActionTry it
Schedule Workflow Signature Request
Schedule a workflow's signature request (the signature packet sent to the signers) to go out at a set time, optionally with a reminder email to the signature coordinator beforehand. At notify_at Ironclad sends the request with no further call, and a sent request cannot be unsent, only cancelled with IRONCLAD_CANCEL_WORKFLOW_SIGNATURE_REQUEST. Until then change the schedule with IRONCLAD_UPDATE_SCHEDULED_WORKFLOW_SIGNATURE_REQUEST or remove it with IRONCLAD_DELETE_SCHEDULED_WORKFLOW_SIGNATURE_REQUEST. The workflow must be in the Sign step and not yet out for signature. To send now use IRONCLAD_SEND_WORKFLOW_SIGNATURE_REQUEST.
ActionTry it
Send Workflow Signature Request
Send a workflow's signature request (the signature packet sent to the signers) out for signature now. This cannot be undone: a sent request can only be cancelled with IRONCLAD_CANCEL_WORKFLOW_SIGNATURE_REQUEST. The workflow must be in the Sign step and every signer must have a signature or initials tag in the packet (tag requirements depend on the signature provider). No tool moves a workflow into the Sign step: it gets there from the Review step once it is fully approved. Track progress with IRONCLAD_LIST_WORKFLOW_SIGNERS (or IRONCLAD_GET_WORKFLOW_SIGN_STATUS on OAuth connections). To send at a later time use IRONCLAD_SCHEDULE_WORKFLOW_SIGNATURE_REQUEST.
ActionTry it
Supersede Record
Mark a record as superseded on specified recorded and effective dates, optionally linking its replacement record.
ActionTry it
Terminate Record
Terminate a record on specified recorded and effective dates, optionally linking the record that caused termination.
ActionTry it
Undo Record Lifecycle Action
Reverse a specified lifecycle action previously applied to a record. This does not edit ordinary record metadata.
ActionTry it
Update Entity
Change selected parts of an entity: its name, relationship type, status, parent, and properties to add or remove. Read the entity with IRONCLAD_GET_ENTITY first to see its property ids, which are defined per company, and get relationship type keys from IRONCLAD_LIST_ENTITY_RELATIONSHIP_TYPES. Property values are wrapped as {type, value}.
ActionTry it
Update Obligation
Change an obligation's name, type or properties; send at least one field to change. status, due_date, assignee_user_id and description can be changed only on an occurrence, and only when source_obligation_id is sent too. Read the obligation with IRONCLAD_GET_OBLIGATION first to see its property ids, and wrap each value as {type, value}. The tenant-defined obligation type key must already be known and cannot be discovered by this toolkit because the documented public.obligations.readTypes scope is absent from OAuth's scope catalog. Needs the public.obligations.updateObligations scope, a paid add-on not requested by default: add it to the auth config.
ActionTry it
Update Record
Change selected parts of a record and leave the rest as it is: add or overwrite properties, remove properties, rename it, change its type, and edit its links, parent and children. Property ids and types are defined per company: get them from IRONCLAD_GET_RECORDS_SCHEMA, and wrap each value as {type, value}. To overwrite the whole record use IRONCLAD_REPLACE_RECORD; fields of a workflow in progress are changed with IRONCLAD_UPDATE_WORKFLOW_ATTRIBUTES. address_as_object only changes the representation of addresses in the update response and does not count as a field update; use IRONCLAD_GET_RECORD for a read-only request.
ActionTry it
Update Scheduled Workflow Signature Request
Change the send time or the reminder of the signature request already scheduled on a workflow with IRONCLAD_SCHEDULE_WORKFLOW_SIGNATURE_REQUEST. notify_at may be earlier as well as later than the current time (Ironclad documents no limit): at the new time Ironclad sends the request to the signers with no further call, and a sent request cannot be unsent, only cancelled with IRONCLAD_CANCEL_WORKFLOW_SIGNATURE_REQUEST. The workflow must be in the Sign step and not yet out for signature. Pass reminder as null to remove an existing reminder.
ActionTry it
Update Workflow Approval
Approve a workflow on behalf of one approver role, or set that approval back to pending, as the user the connection acts as. Ironclad allows the change only in the Review step while that role's approval group is active (its turn to approve), so this tool cannot withdraw an approval once the group is no longer active. It also works only when that user is currently assigned as the approver: compare with the role's assignees on IRONCLAD_LIST_WORKFLOW_APPROVALS, which gives role_id and shows which group is active. No tool in this toolkit names the connected user.
ActionTry it
Update Workflow Attributes
Set or clear attribute (form field) values on a workflow that is in the Review step, and return the updated workflow. Call IRONCLAD_GET_WORKFLOW first: its attributes give the attribute ids and current values and its schema_ gives each type (IRONCLAD_GET_WORKFLOW_SCHEMA covers only launch-form fields). Form validation applies: a required attribute cannot be removed, a read-only one cannot be changed, and Ironclad rejects a call that changes nothing. It cannot change document attributes (use IRONCLAD_UPLOAD_WORKFLOW_DOCUMENT or IRONCLAD_UPDATE_WORKFLOW_SIGNATURE_PACKET), and stored records are changed with IRONCLAD_UPDATE_RECORD.
ActionTry it
Update Workflow Role Assignment
Assign a workflow role such as Archiver or Signature Coordinator to a different user. role_name is the role's display name from roles on IRONCLAD_GET_WORKFLOW or IRONCLAD_LIST_WORKFLOW_APPROVALS, not a role id. The user must be eligible for the role: check with IRONCLAD_LIST_WORKFLOW_ROLE_ELIGIBLE_ASSIGNEES. If the role is tied to another role in the workflow design the user is assigned to both. To change who signs use IRONCLAD_UPDATE_WORKFLOW_SIGNER.
ActionTry it
Update Workflow Signature Packet
Replace the ordered list of documents in a workflow's signature packet, the documents a signature request sends to the signers. Documents you list are put in the packet in that order; documents currently in the packet that you leave out are moved out of it. The workflow must be in the Review step. Get the document keys from IRONCLAD_LIST_WORKFLOW_DOCUMENTS.
ActionTry it
Update Workflow Signer
Reassign a signer role of a workflow to another signer, or change an external signer's name or email. If the request is already out for signature, the original signer is emailed that it was reassigned, and with Adobe Sign the signature request is cancelled; neither can be undone. A signer who has already signed cannot be updated. Get role names from IRONCLAD_LIST_WORKFLOW_SIGNERS. For a workflow role that is not a signer use IRONCLAD_UPDATE_WORKFLOW_ROLE_ASSIGNMENT.
ActionTry it
Upload Record Attachment
Attach a file to a contract record under an attachment key. A key the record already uses is rejected: the keys in use are listed under attachments on IRONCLAD_GET_RECORD, and the keys the repository defines (such as signedCopy) under attachments in IRONCLAD_GET_RECORDS_SCHEMA. To replace a file, remove the old one with IRONCLAD_DELETE_RECORD_ATTACHMENT first, then upload under the same key. For documents of a workflow in progress use IRONCLAD_UPLOAD_WORKFLOW_DOCUMENT.
ActionTry it
Upload Signed Workflow Document
Upload a signed PDF to a workflow that is in the Sign step. Without signer_role_names the document counts as fully signed and the workflow completes the Sign step, which cannot be undone; pass signer_role_names to record a partially signed copy instead. Uploading while a signature packet is out cancels the in-flight request and may email signers. mute_cancellation_notifications can suppress that email only for Ironclad Signature and Adobe Sign; DocuSign cannot suppress it, Dropbox Sign does not send one, and unsupported in-flight providers return 400 INVALID_PARAM when the flag is true. The flag is ignored when no request is out. For drafts and supporting documents use IRONCLAD_UPLOAD_WORKFLOW_DOCUMENT.
ActionTry it
Upload Workflow Document
Upload a PDF or Word file into a document attribute of a workflow, with a required comment. With document_key the file becomes a new version of that existing draft document; without it the file is added to the attribute. For a signed copy use IRONCLAD_UPLOAD_SIGNED_WORKFLOW_DOCUMENT; for a file on a stored record use IRONCLAD_UPLOAD_RECORD_ATTACHMENT.
ActionTry it
How the Ironclad integration works
The Ironclad integration connects your Dench AI CRM directly to Ironclad, so agents can read and act on your Ironclad data as part of everyday work — answering questions in chat, keeping your CRM in sync, and running automations without anyone copying data between tools.
80 actions are available for agents to invoke on your behalf. Every call runs through Ironclad's own authorization, scoped to the account you connect.
Set up Ironclad in Dench
- 1
Sign in to your Dench workspace and open Integrations.
- 2
Find Ironclad and click Connect — you'll authorize access through Ironclad's own sign-in flow. No API keys or code required.
- 3
Ask an agent to use Ironclad in chat, or call it from an automation.
- 4
Manage or disconnect the connection any time from workspace settings.
Frequently asked questions
How does the Ironclad integration work with Dench?
The Dench Ironclad integration connects your AI CRM to Ironclad, so AI agents can work with your Ironclad data as part of chats, automations, and CRM workflows. You connect your account once, and every agent in your workspace can use it — governed by your workspace permissions.
What actions can AI agents perform with Ironclad via Dench?
The Ironclad integration currently exposes 80 actions, including Activate Record, Cancel Record Auto-Renewal, Cancel Workflow, Cancel Workflow Signature Request, Create Data Export, and Create Embedded Workflow Signature Recipient URL. Agents invoke them on your behalf from chat or from automations.
Do I need to write code to connect Ironclad to Dench?
No. You connect Ironclad from your Dench workspace using Ironclad's own sign-in and authorization flow — no API keys to copy, no glue code to maintain.
Is the Ironclad integration secure?
Connections are authorized through Ironclad's own authentication flow, and Dench stores only the authorization needed to act on your behalf. You can review and disconnect the Ironclad connection from your workspace settings at any time.