Skip to content
POST /unified/e-signature/workflows

Query Parameters

Refer Specifying query parameters in Truto APIs

Show Truto-specific parameters
integrated_account_idstring · uuid
required·

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

Example: 62f44730-dd91-461e-bd6a-aedd9e0ad79d
truto_response_formatstring

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.
  • debug returns the final unified result alongside raw remote fetch information. The response is an envelope containing result (identical to unified mode output) and debug (with requestUrl, requestOptions, data, responseHeaders, and for list operations: nextCursor, isLooping, isEmptyResult, resultCount). debug is null for static responses or when truto_skip_api_call=true.

Defaults to unified.

Example: unified
Possible values:
unifiedrawnormalizedstreamdebug
truto_ignore_remote_databoolean

Excludes the remote_data attribute from the response.

truto_enforce_write_schemaboolean

Validates the request body against this method's request_body_schema before the request is sent to the underlying integration. When a field marked required is missing, Truto responds 400 with the missing field names under truto_error_insight.missing_required_body_fields instead of forwarding the call. Only the fields documented in request_body_schema are checked. A body carrying a non-empty remote_data object is forwarded unchecked, because remote_data is merged into the provider request and may already carry the required values. A field the mapping always supplies through its default body is treated as present, and a field that is only conditionally required is reported under truto_error_insight.conditionally_required_body_fields rather than rejected. Some integrations declare fields required on update that the provider only requires on create; check meta/{method} for the resource before enabling this on update calls. If you sent an Idempotency-Key and the request was rejected, use a fresh key when you retry with a corrected body: the idempotency cache is keyed on the integrated account, path and key only — it ignores the query string and the body — so reusing the key replays the rejection. Defaults to false, which forwards the request as-is.

truto_exclude_fieldsstring[]

Array of fields to exclude from the response.

Example: truto_exclude_fields[]=id&truto_exclude_fields[]=name
remote_queryRecord<string, any>

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

attachment
1 supported
LinkSquares
supported
custom_fieldsstring

Custom fields related to template.

2 supported1 required
Ironclad
required
LinkSquares
supported
namestring

The name of the workflow.

2 supported1 required
LinkSquares
required
Ironclad
supported
remote_dataRecord<string, any>

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.

template
1 supported1 required
LinkSquares
required
template_idstring

The unique identifier of the template.

1 supported1 required
Ironclad
required
typestring

The type of the workflow.

2 supported1 required
LinkSquares
required
Ironclad
supported

Response Body

created_atstring · date-time

The date and time when the workflow was created.

2 supported
Ironclad
supported
LinkSquares
supported
created_byobject

The user who created the workflow.

2 supported
Ironclad
supported
LinkSquares
supported
idstring

The unique identifier of the user.

namestring

The name of the user.

custom_fieldsRecord<string, any>

All the custom fields present on the workflow

2 supported
Ironclad
supported
LinkSquares
supported
descriptionstring

The description of the workflow.

idstring

The unique identifier of the workflow.

2 supported
Ironclad
supported
LinkSquares
supported
namestring

The name of the workflow.

2 supported
Ironclad
supported
LinkSquares
supported
remote_dataRecord<string, any>

Raw data returned from the remote API call.

stageobject

The stage of the workflow.

2 supported
Ironclad
supported
LinkSquares
supported
idstring

The unique identifier of the stage.

namestring

The name of the stage.

statusstring

The status of the workflow.

Possible values:
activeinactivedrafthidden
1 supported
Ironclad
supported
typestring

The type of the workflow.

2 supported
Ironclad
supported
LinkSquares
supported
updated_atstring · date-time

The date and time when the workflow was last updated.

1 supported
Ironclad
supported
urlsobject[]

The workflow's urls

1 supported
Ironclad
supported
typestring

The workflow's URL type

urlstring

The workflow's URL

truto unified e-signature workflows \
  -m create \
  -a '<integrated_account_id>' \
  -b '{
  "template_id": "your_template_id",
  "custom_fields": "your_custom_fields",
  "name": "your_name",
  "type": "your_type",
  "remote_data": {}
}' \
  -o json
import Truto from '@truto/truto-ts-sdk';

const truto = new Truto({
  token: '<your_api_token>',
});

const result = await truto.unifiedApi.create(
  'e-signature',
  'workflows',
  {
  "template_id": "your_template_id",
  "custom_fields": "your_custom_fields",
  "name": "your_name",
  "type": "your_type",
  "remote_data": {}
},
  { integrated_account_id: '<integrated_account_id>' }
);

console.log(result);
import asyncio
from truto_python_sdk import TrutoApi

truto_api = TrutoApi(token="<your_api_token>")

async def main():
    result = await truto_api.unified_api.create(
        "e-signature",
        "workflows",
        {
        "template_id": "your_template_id",
        "custom_fields": "your_custom_fields",
        "name": "your_name",
        "type": "your_type",
        "remote_data": {}
},
        {"integrated_account_id": "<integrated_account_id>"}
    )
    print(result)

asyncio.run(main())
curl -X POST 'https://api.truto.one/unified/e-signature/workflows?integrated_account_id=<integrated_account_id>' \
  -H 'Authorization: Bearer <your_api_token>' \
  -H 'Content-Type: application/json' \
  -d '{
  "template_id": "your_template_id",
  "custom_fields": "your_custom_fields",
  "name": "your_name",
  "type": "your_type",
  "remote_data": {}
}'
const integratedAccountId = '<integrated_account_id>';

const body = {
  "template_id": "your_template_id",
  "custom_fields": "your_custom_fields",
  "name": "your_name",
  "type": "your_type",
  "remote_data": {}
};

const response = await fetch(`https://api.truto.one/unified/e-signature/workflows?integrated_account_id=${integratedAccountId}`, {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer <your_api_token>',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify(body),
});

const data = await response.json();
console.log(data);
import requests

url = "https://api.truto.one/unified/e-signature/workflows"
headers = {
    "Authorization": "Bearer <your_api_token>",
    "Content-Type": "application/json",
}
params = {
    "integrated_account_id": "<integrated_account_id>"
}
payload = {
    "template_id": "your_template_id",
    "custom_fields": "your_custom_fields",
    "name": "your_name",
    "type": "your_type",
    "remote_data": {}
}

response = requests.post(url, headers=headers, params=params, json=payload)
print(response.json())