Sign in

v1

latestOpenAPI 3.1.02026-07-2498134321.1 KB
Workflows

Create a Workflow Synchronously

Launch a new Workflow synchronously.

OAuth Scope required: public.workflows.createWorkflows

post/workflows

Query parameters

useDefaultValuesboolean

If values are not specified for a given field, use the default values specified in the launch form configuration.

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

templatestring required

The identifier of the workflow template

Example request

{
  "template": "600b296c3e15a234ab88f884",
  "attributes": {
    "counterpartyName": "Example Company",
    "draft": [
      {
        "url": "https://www.law.berkeley.edu/wp-content/uploads/2018/12/Resume-Samples-1.pdf"
      }
    ],
    "localLinkedRecord": "IC-123",
    "localParentRecord": "IC-456",
    "localChildRecord": "IC-789"
  },
  "creator": {
    "email": "example@example.com"
  }
}

Response

Launched Workflow Response.

idstring required

The ID of the launched workflow.

ironcladIdstring

The Ironclad ID of the launched workflow.

titlestring required

The name used for the launched workflow.

templatestring required

The identifier of the workflow template

step'Review' | 'Sign' | 'Archive' | 'Complete' required

The step the workflow is currently on.

attributesobject required

The workflow attributes (also known as properties). Attributes of type linkedRecord, parentRecord, or childRecord are returned as objects with recordId and readableId.

isCancelledboolean required

Displays if the launched workflow has been cancelled.

isCompleteboolean required

Displays if the launched workflow has been completed.

status'active' | 'paused' | 'cancelled' | 'completed' required

The current status of the launched workflow.

createdstring required

The date (ISO8601 format) the workflow was launched

lastUpdatedstring required

The date (ISO8601 format) the workflow was last updated

recordIdsstring[]
isRevertibleToReviewboolean required

Displays if the launched workflow can be reverted back to the review step.

Example response

{
  "id": "6013609108b8f070cee94fc1",
  "ironcladId": "IC-1",
  "title": "Consulting Agreement with Jane Doe",
  "template": "600b296c3e15a234ab88f884",
  "step": "Review",
  "schema": {
    "counterpartyName": "Example Company",
    "draft": [
      {
        "url": "https://www.law.berkeley.edu/wp-content/uploads/2018/12/Resume-Samples-1.pdf"
      }
    ],
    "localLinkedRecord": "IC-123",
    "localParentRecord": "IC-456",
    "localChildRecord": "IC-789"
  },
  "status": "active",
  "creator": {
    "id": "63d415e0dd0d828c3a878548",
    "email": "fett@intergalactic.com",
    "displayName": "Boba Fett"
  },
  "created": "2016-11-17T00:37:22.318Z",
  "lastUpdated": "2016-11-17T00:37:42.318Z",
  "roles": [
    {
      "id": "legal",
      "displayName": "Legal",
      "assignees": [
        {
          "userName": "Boba Fett",
          "userId": "63d415e0dd0d828c3a878548",
          "email": "bobafett@example.com"
        }
      ]
    }
  ],
  "approvals": {
    "state": "in_progress"
  },
  "signatures": {
    "state": "in_progress",
    "url": "https://na1.ironcladapp.com/public/api/v1/workflows/6dac47a10b1242d1f7df688d/signatures"
  },
  "recordIds": [
    "715f1e37-292f-4e6c-8b48-c07e1b68bccd"
  ]
}