v1

latestOpenAPI 3.1.02026-07-2498134321.1 KB

Workflows

Update Workflow Metadata

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.

Note: This endpoint does not support updating document/file type attributes. To manage documents, use the Create a Document on a Workflow and Update Signature Packet on a Workflow endpoints.

OAuth Scope required: public.workflows.updateWorkflows

patch/workflows/{id}/attributes

Path parameters

idstring required

The unique identifier or Ironclad ID of a workflow.

Headers

x-as-user-emailstring

Example:jane.doe@test.com

Denotes the actor of the request. When used, the API will take into account this user's permissions and access. This or x-as-user-id is required when the associated token was produced from the Client Credentials grant or with legacy bearer tokens on select endpoints. More information about permissions.

x-as-user-idstring

Example:5f0375c4cdc1927a3c5edcd3

Denotes the actor of the request. When used, the API will take into account this user's permissions and access. This or x-as-user-email is required when the associated token was produced from the Client Credentials grant or with legacy bearer tokens on select endpoints. More information about permissions.

Request body

commentstring

A comment that explains the updates you are making to the workflow.

Example request

{
  "updates": [
    {
      "path": "counterpartyName",
      "value": "Example Company"
    }
  ],
  "comment": "Changing attribute on a Workflow."
}

Response

200

idstring

ironcladIdstring

titlestring

templatestring

stepstring

isCancelledboolean

isCompleteboolean

statusstring

createdstring

lastUpdatedstring

recordIdsstring[]

isRevertibleToReviewboolean

Example response

{
  "id": "6013609108b8f070cee94fc1",
  "ironcladId": "IC-1",
  "title": "Consulting Agreement with Jane Doe",
  "template": "600b296c3e15a234ab88f884",
  "step": "Review",
  "schema": {
    "counterpartyName": {
      "type": "string",
      "displayName": "Example String Attribute",
      "propertyKey": "counterpartyName",
      "readOnly": true
    },
    "amount": {
      "type": "number",
      "displayName": "Example Number Attribute",
      "propertyKey": "amount"
    },
    "fee": {
      "type": "monetaryAmount",
      "displayName": "Example Monetary Amount Attribute",
      "propertyKey": "fee"
    },
    "draft": {
      "type": "array",
      "elementType": {
        "type": "document",
        "displayName": "Example Document Attribute"
      }
    },
    "lineItems": {
      "type": "array",
      "elementType": {
        "type": "object",
        "displayName": "Example Object Attribute",
        "schema": {
          "childAttribute": {
            "type": "string",
            "displayName": "Example String Attribute"
          },
          "anotherChildAttribute": {
            "type": "string",
            "displayName": "Example String Attribute"
          }
        }
      }
    }
  },
  "attributes": {
    "counterpartyName": "Boba Fett",
    "amount": 123,
    "fee": {
      "currency": "USD",
      "amount": 50000
    },
    "draft": [
      {
        "version": "B1QePArXb",
        "filename": "file.pdf",
        "download": "/public/api/v1/workflows/594356b9fbcd7f74006fdf8a/document/rJklwCHQ/download"
      }
    ]
  },
  "status": "active",
  "creator": {
    "displayName": "Boba Fett",
    "email": "fett@intergalactic.com",
    "id": "63d415e0dd0d828c3a878548"
  },
  "created": "2016-11-17T00:37:22.318Z",
  "lastUpdated": "2016-11-17T00:37:22.318Z",
  "roles": [
    {
      "id": "legal",
      "displayName": "Legal",
      "assignees": [
        {
          "userName": "Boba Fett",
          "userId": "63d415e0dd0d828c3a878548",
          "email": "bobafett@example.com"
        }
      ]
    }
  ],
  "approvals": {
    "state": "in_progess",
    "url": "https://na1.ironcladapp.com/public/api/v1/workflows/22e2ff72-56a1-4711-a4ca-41328d311e9f/approvals"
  },
  "signatures": {
    "state": "in_progess",
    "url": "https://na1.ironcladapp.com/public/api/v1/workflows/6dac47a10b1242d1f7df688d/signatures"
  },
  "recordIds": [
    "715f1e37-292f-4e6c-8b48-c07e1b68bccd"
  ]
}