Sign in

v1

latestOpenAPI 3.1.02026-07-2498134321.1 KB
Workflows

Create a Workflow Asynchronously

Launch a new Workflow asynchronously for non-blocking performance, which is helpful when/if you provide files to the Workflow.

OAuth Scope required: public.workflows.createWorkflows

post/workflows/async

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

The response of the initiated async workflow launch.

asyncJobIdstring required
asyncJobStatusUrlstring required

Example response

{
  "asyncJobId": "jobIda89474a8ba364f79bb510517d7bd3fea",
  "asyncJobStatusUrl": "https://na1.ironcladapp.com/public/api/v1/workflows/async/jobIda89474a8ba364f79bb510517d7bd3fea"
}