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

Update template

PUT

https://api.signater.com/v1/ecm/templates/{templateId}

Template

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

Updates an existing template with new content, structure, or fields. This allows you to modify predefined elements of the template to reflect changes in document requirements. The updated template can then be used to create new documents and envelopes, ensuring that future documents align with the latest configuration and structure.

Request

Authorization

Add parameter in header

x-api-token

Example:

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

Path Params

templateId

string <uuid>

required

Template ID

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 (UpdateTemplateFieldApiRequest) {7}] | null

optional

Fields of the template

string <uuid> | null

optional

Id of the field

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": "4b015697-0676-4f3a-a09a-e12540e0d640",
  "name": "Contract Template",
  "description": "A template description for contracts between parties.",
  "payload": "{ \"key\": \"value\" }",
  "fields": [
    {
      "id": "1a2a809b-7799-4004-8a8d-716867f0a8a4",
      "name": "First Name",
      "alias": "first_name",
      "description": "The first name of the individual.",
      "isRequired": true,
      "type": "Text",
      "customRegex": null
    },
    {
      "id": null,
      "name": "Age",
      "alias": "age",
      "description": "The age of the individual.",
      "isRequired": false,
      "type": "Number",
      "customRegex": null
    },
    {
      "id": 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 PUT 'https://api.signater.com/v1/ecm/templates/' \
--header 'Content-Type: application/json' \
--data-raw '{
    "vaultId": "4b015697-0676-4f3a-a09a-e12540e0d640",
    "name": "Contract Template",
    "description": "A template description for contracts between parties.",
    "payload": "{ \"key\": \"value\" }",
    "fields": [
        {
            "id": "1a2a809b-7799-4004-8a8d-716867f0a8a4",
            "name": "First Name",
            "alias": "first_name",
            "description": "The first name of the individual.",
            "isRequired": true,
            "type": "Text",
            "customRegex": null
        },
        {
            "id": null,
            "name": "Age",
            "alias": "age",
            "description": "The age of the individual.",
            "isRequired": false,
            "type": "Number",
            "customRegex": null
        },
        {
            "id": null,
            "name": "Score",
            "alias": "score",
            "description": "Score number.",
            "isRequired": false,
            "type": "Custom",
            "customRegex": "^[0-9]+$"
        }
    ]
}'

Responses

🟢204No Content

Template updated successfully

This response does not have a body.

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Record Not Found

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

Get template

Remove template