Signatures

Envelope Create From Template

POST
/signatures/template/{templateId}/envelope/create

Creates an envelope based on a provided template.

  • Use the templateId parameter to specify the template.
  • Documents must first be uploaded via the Storage endpoint and linked to recipients using referenceDocumentId and referenceSignerId.
  • Template roles are converted into envelope recipients. Recipients/signGroups provided in the request override the matching stored template recipient by templateRole; anything omitted falls back to the template's stored value.

Authorization

AuthorizationBearer <token>

JWT token to authenticate the request.

In: header

X-Api-Key<token>

API key, sent as a request header.

In: header

Path Parameters

templateId*string

The ID of the template based on which the envelope is created.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

curl -X POST "https://example.com/signatures/template/string/envelope/create" \  -H "Content-Type: application/json" \  -d '{    "envelope": {      "subject": "TestPostman",      "message": ""    },    "message": {      "subject": "TestPostman",      "recipients": [        {          "templateRole": "Role1",          "name": "RomanK",          "email": "roman.khryshchanovich@mavenmule.com"        }      ]    },    "signGroups": []  }'
{  "result": {    "statusCode": 201,    "message": "Created",    "data": {      "template": {        "id": "string",        "uploadDate": "string"      },      "documents": [        {          "id": "string",          "externalContext": {}        }      ],      "recipients": [        {          "id": "string",          "externalContext": {}        }      ],      "signGroups": [        {          "id": "string"        }      ],      "fields": [        {          "id": "string",          "recipientId": "string",          "signGroupId": "string",          "documentId": "string"        }      ]    }  },  "origin": "string",  "dateTime": "string"}
{  "error": {    "message": "Envelope not found.",    "statusCode": 400,    "innerErrors": [      {        "code": "ENVELOPE_ID_INVALID",        "message": "Envelope not found.",        "userMessage": "Envelope not found."      }    ]  },  "origin": "POST https://apim-mavenheadless-dev-westeu-1.azure-api.net/v1/signatures/envelope/create",  "dateTime": "2026-07-20T12:00:00.0000000+00:00"}
{  "error": {    "message": "Envelope not found.",    "statusCode": 400,    "innerErrors": [      {        "code": "ENVELOPE_ID_INVALID",        "message": "Envelope not found.",        "userMessage": "Envelope not found."      }    ]  },  "origin": "POST https://apim-mavenheadless-dev-westeu-1.azure-api.net/v1/signatures/envelope/create",  "dateTime": "2026-07-20T12:00:00.0000000+00:00"}