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

Template

Last modified:2025-03-29 12:47:42

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

vaultId

string <uuid>

required

Id of the vault

>= 1 characters

name

string

required

Name of the template

>= 2 characters<= 200 characters

description

string | null

optional

Description of the template

<= 4000 characters

payload

string | null

optional

Payload of the template

fields

array[object (CreateTemplateFieldApiRequest) {6}] | null

optional

Fields of the template

name

string

required

Name of the field

>= 2 characters<= 200 characters

alias

string

required

Alias of the field, must be unique and only contain alphanumeric characters, dashes and underscores

>= 2 characters<= 200 characters

Match pattern:

^[a-zA-Z0-9_-]*$

description

string | null

optional

Description of the field

<= 4000 characters

isRequired

boolean

required

Indicates if the field is required

type

enum<string>

required

Type of the field

>= 1 characters

Allowed values:

BrCepBrCpfBrCnpjDateOnlyTimeOnlyDateTimeEmailNumberTextCustom

customRegex

string | null

optional

Custom regex when Type is Custom

<= 200 characters

Example

{
  "vaultId": "7d189a0a-c323-4fa7-b528-1956b83156c1",
  "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 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 'Content-Type: application/json' \
--data-raw '{
    "vaultId": "7d189a0a-c323-4fa7-b528-1956b83156c1",
    "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

string <uuid>

optional

Id of the template

Example

{
  "id": "b06f3576-39ff-4ef6-a2ce-3f2a7d98d4d1"
}

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

Modified at 2025-03-29 12:47:42

Remove template

Rename template