patch https://ironcladapp.com/public/api/v1/workflows//attributes
The workflow must be in the Review step in order for its data to be updated. Use the remove action to clear field values and the set action to add or modify values. Form validation is enforced; required fields cannot be removed and any required fields triggered by conditions must be populated.
OAuth Scope required: public.workflows.updateWorkflows
Field Type Formats
Updates to field values must conform to the format expected by the field type. See the following examples for valid formats.
Note: Currently, this endpoint does not support making updates to record links, documents, or fields generated by functions. For formula fields, the
readOnlyproperty will betruewhen retrieving workflow data.
"updates": [
{
"action": "set",
"path": "counterpartyName",
"value": "Test LLC"
}
]
"updates": [
{
"action": "set",
"path": "emailAttribute",
"value": "[email protected]"
}
]
"updates": [
{
"action": "set",
"path": "numberAttribute",
"value": 3
}
]
"updates": [
{
"action": "set",
"path": "booleanAttribute",
"value": true
}
]
// ISO-8601 date
"updates": [
{
"action": "set",
"path": "dateAttribute",
"value": "2021-04-01T12:30:49-07:00"
}
]
"updates": [
{
"action": "set",
"path": "someDynamicTable",
"value": [
{
"lineItem1": "lineItem",
"lineItem2": "lineItem2"
}
]
}
]
"updates": [
{
"action": "set",
"path": "monetaryAmountAttribute",
"value": {
"currency": "USD",
"amount": 1000
}
}
]
"updates": [
{
"action": "set",
"path": "addressAttribute",
"value": {
"lines": ["123 DogDay Road"],
"locality": "San Francisco",
"country": "United States",
"region": "California",
"postcode" "94118"
}
]
/* If desired, objects such as dynamic tables can also be modified
using dot notation to target specific object attributes instead of updating the full object.
See examples of object structure in the other tabs. */
"updates": [
{
"action": "set",
"path": "someDynamicTable[0].someNumberFieldInDynamicTable",
"value": 25
}
]