This document is generated by Apidog. Apidog: All-in-one workspace for API design, document, debug, test, mock

Create template

POST

https://api.signater.com/v1/ecm/templates

Last modified:2025-12-20 00:13:34

Creates a new template that can be used to generate documents and envelopes. Templates allow you to define predefined structures and fields, which can be reused across multiple documents, saving time and ensuring consistency in document creation. Once created, the template can be accessed and used to quickly generate new documents with the same configuration.

Request

Authorization

Add parameter in header

x-api-token

Example:

x-api-token: ********************

Body Params application/json

Example

{
    "vaultId": "766ac1ef-834e-471e-b3bf-fc1d86834008",
    "name": "Contract Template",
    "description": "A template description for contracts between parties.",
    "payload": "{ \"key\": \"value\" }",
    "fields": [
        {
            "name": "First Name",
            "alias": "first_name",
            "description": "The first name of the individual.",
            "isRequired": true,
            "type": "Text",
            "customRegex": null
        },
        {
            "name": "Age",
            "alias": "age",
            "description": "The age of the individual.",
            "isRequired": false,
            "type": "Number",
            "customRegex": null
        },
        {
            "name": "Score",
            "alias": "score",
            "description": "Score number.",
            "isRequired": false,
            "type": "Custom",
            "customRegex": "^[0-9]+$"
        }
    ]
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.signater.com/v1/ecm/templates' \
--header 'x-api-token: <api-key>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "vaultId": "766ac1ef-834e-471e-b3bf-fc1d86834008",
    "name": "Contract Template",
    "description": "A template description for contracts between parties.",
    "payload": "{ \"key\": \"value\" }",
    "fields": [
        {
            "name": "First Name",
            "alias": "first_name",
            "description": "The first name of the individual.",
            "isRequired": true,
            "type": "Text",
            "customRegex": null
        },
        {
            "name": "Age",
            "alias": "age",
            "description": "The age of the individual.",
            "isRequired": false,
            "type": "Number",
            "customRegex": null
        },
        {
            "name": "Score",
            "alias": "score",
            "description": "Score number.",
            "isRequired": false,
            "type": "Custom",
            "customRegex": "^[0-9]+$"
        }
    ]
}'

Responses

🟢201Created

application/json

Template created successfully

Body

Example

{
    "id": "0115d343-3f38-481c-88c7-319a8c267985"
}

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

Modified at 2025-12-20 00:13:34

Remove template

Rename template