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}

Last modified:2025-08-24 00:13:59

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

Body Params application/json

Example

{
    "vaultId": "c8d637fe-8413-4c52-80ed-b4aead0c333f",
    "name": "Contract Template",
    "description": "A template description for contracts between parties.",
    "payload": "{ \"key\": \"value\" }",
    "fields": [
        {
            "id": "89068cdf-82b3-439e-adf1-a40d77d1c866",
            "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 Code 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' \
--header 'x-api-token;' \
--data-raw '{
    "vaultId": "c8d637fe-8413-4c52-80ed-b4aead0c333f",
    "name": "Contract Template",
    "description": "A template description for contracts between parties.",
    "payload": "{ \"key\": \"value\" }",
    "fields": [
        {
            "id": "89068cdf-82b3-439e-adf1-a40d77d1c866",
            "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-08-24 00:13:59

Get template

Remove template