Appearance

Create Workflows ​

Endpoint ​

http
POST /unified/e-signature/workflows
Integrations supported
  • Ironclad
  • LinkSquares

Query parameters ​

Refer Specifying query parameters in Truto APIs

integrated_account_id
string · uuid
REQUIRED · 

The ID of the integrated account to use for the request.

Example: 62f44730-dd91-461e-bd6a-aedd9e0ad79d
truto_response_format
string

The format of the response.

  • unified returns the response with unified mappings applied.
  • raw returns the unprocessed, raw response from the remote API.
  • normalized applies the unified mappings and returns the data in a normalized format.
  • stream returns the response as a stream, which is ideal for transmitting large datasets, files, or binary data. Using streaming mode helps to efficiently handle large payloads or real-time data flows without requiring the entire data to be buffered in memory.

Defaults to unified.

All possible enum values:
  • unified
  • raw
  • normalized
  • stream
Example: unified
truto_ignore_remote_data
boolean

Excludes the remote_data attribute from the response.

truto_exclude_fields
array

Array of fields to exclude from the response.

Example: truto_exclude_fields[]=id&truto_exclude_fields[]=name
remote_query
object

Query parameters to pass to the underlying API without any transformations. Refer this guide to see how to structure the query parameters.

Example: remote_query[foo]=bar

Request Body ​

Refer Writing data using Unified APIs

template_id
string

The unique identifier of the template.

Required in
  • Ironclad
custom_fields
string

Custom fields related to template.

Required in
  • Ironclad
name
string

The name of the workflow.

Required in
  • LinkSquares
type
string

The type of the workflow.

Required in
  • LinkSquares
template
Required in
  • LinkSquares
attachment
Supported in
  • LinkSquares
remote_data
object

Any additional data that should be passed as part of the request body. This data is not transformed by Truto and is passed as is to the remote API.

Response Body ​

id
string

The unique identifier of the workflow.

Supported in
  • Ironclad
  • LinkSquares
name
string

The name of the workflow.

Supported in
  • Ironclad
  • LinkSquares
description
string

The description of the workflow.

type
string

The type of the workflow.

Supported in
  • Ironclad
  • LinkSquares
status
string

The status of the workflow.

All possible enum values:
  • active
  • inactive
  • draft
  • hidden
Supported in
  • Ironclad
created_by
object

The user who created the workflow.

Supported in
  • Ironclad
  • LinkSquares
id
string

The unique identifier of the user.

name
string

The name of the user.

created_at
string · date-time

The date and time when the workflow was created.

Supported in
  • Ironclad
  • LinkSquares
updated_at
string · date-time

The date and time when the workflow was last updated.

Supported in
  • Ironclad
stage
object

The stage of the workflow.

Supported in
  • Ironclad
  • LinkSquares
id
string

The unique identifier of the stage.

name
string

The name of the stage.

custom_fields
object

All the custom fields present on the workflow

Supported in
  • Ironclad
urls
object[]

The workflow's urls

Supported in
  • Ironclad
url
string

The workflow's URL

type
string

The workflow's URL type

remote_data
object

Raw data returned from the remote API call.