GuidesAPI ReferenceRecipes
Guides
Request a Demo

Field Types Supported for Workflows


👍

Tip: Constructing Request Bodies

A shortcut for creating a sample request body is to manually launch a workflow with test values in Ironclad. After the workflow launches, send a request to the Retrieve a Workflow endpoint to get the field IDs and properly formatted values under the attributes property.

📘

Supported Field Types

Population of formula fields is not currently supported via API. Consider passing data into string fields or moving fields to an Internal Form for users to fill in after a workflow is launched.

Field TypeSample Value
String

Note: Strings have a 32,000 character limit. Workflows will error at the archive step if it is exceeded.		"counterpartyName": "Acme LLC"
Address

Note: Addresses are validated.
  • Non-US addresses require (1) street (lines), (2) locality, and (3) country.
  • US addresses require (1) street (lines), (2) locality, (3) region, (4) postcode, and (5) country. US address validation is enforced if U.S.A., USA, United States, or United States of America are used as the country.
  • The lines array is limited to four street lines.
"counterpartyAddress": {
    "lines": [
      "325 5th Street",
        "Suite 200"
    ],
    "locality": "San Francisco", 
    "region": "California",
    "postcode": "94107",
    "country": "USA"
}
Number"standard_timesRenewed": 12
Monetary Value"totalContractValue": {
    "currency": "USD",
    "amount": 25.37
}
DateDate fields accept multiple formats:
"agreementDate": "2021-05-11T17:16:53-07:00"
    OR
"agreementDate": "2021-05-11"
    OR
"agreementDate": "2021-05-11T17:16:53Z"
Duration
The duration value must include one or more units of time (years, months, weeks, or days).		"initialTermLength": {
    "years": 1,
    "months": 2,
    "weeks": 3,
    "days": 4
}
Email"counterpartySignerEmail": "[email protected]"
Boolean

Note: The Yes/No field field in Workflow Designer is a boolean.
"contractExtending": true
Single-Select (Same as String)"protectionPeriod": "Option A"
Multi-Select

"someMultiSelectField": [

  "Option A",
   "Option B"
]

Table"someTable": [
    {
        "someTextFieldInTable": "Some Row 1 Text",
        "someNumberFieldInTable": 25,
        "someMultiSelectFieldInTable": ["Option A", "Option B"]
    },
    {
        "someTextFieldInTable": "Some Row 2 Text",
        "someNumberFieldInTable": 27,
        "someMultiSelectFieldInTable": ["Option B", "Option C"]
    }
]
File

Note: See Section 3.5 for full details on usage and requirements. Files can either be sent as (1) binaries directly in a multipart/form-data request or (2) publicly accessible URLs in a regular raw JSON request body. The two methods cannot be combined.		Option 1: Multipart/Form-Data Request
The value of the file property below is the request body part name that you plan to include the file's binary under. See Section 3.5.1 for more details.
"draft": [ { "file": "someFirstFile" },
{ "file": "someSecondFile" } ]


Option 2: Publicly Accessible URLs
// The urls below are stubs. Please replace them with urls that point to your own files.

"draft": [
{"url": "https://your.file.server/testdoc-1.docx"},
{"url": "https://your.file.server/testdoc-2.docx" }
]
User Role

"approver3be1d629ad524bb2aade2078cd06e94": "682b83ea0303cccab88b4ce"

OR

"approver3be1d629ad524bb2aade2078cd06e94": "[email protected]"

Related Record

The value of a Related Record field should be either the readable ID (e.g. "IC-456") or the UUID of the record to set:

"customRelatedRecordKey": "67818c492207a528ce9665ad"

OR

"customRelatedRecordKey": "IC-68"

Entity

entity_reference": "ENTITY-1"

OR

"entity_reference": "0f1a6991-5e34-4945-89aa-eadc54eed62c"