GuidesAPI ReferenceRecipes
API Reference
Request a Demo

Create a Workflow Synchronously

post
https://na1.ironcladapp.com/public/api/v1/workflows

Launch a new Workflow synchronously.

OAuth Scope required: public.workflows.createWorkflows

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
boolean
Defaults to false

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

Body Params
string
required

The identifier of the workflow template

attributes
object
required

The data that will be used to populate the workflow's fields. Learn more about the various attributes and their associated types by viewing the Launch a Workflow guide. Your attributes will differ and include more than this simple example.

creator

The Ironclad user (must be a user in your Ironclad account) to be used for launching the workflow. This is required when using a legacy bearer token but will be ignored when using an OAuth token. If the token was generated with the Authorization Code grant, the associated token user will be used. If the token was generated with the Client Credentials grant, the required x-as-user-id or x-as-user-email header will be used.

Headers
string

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.

string

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.

Responses

Updated about 6 hours ago

What’s Next
Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 6 hours ago

What’s Next