Skip to main content

Create a template

POST 
/v1/sign/templates

Creates a new template owned by the caller's organization. Two modes, selected by whether documents is supplied:

  • Empty template (omit documents): creates an empty template from just name (plus optional description/type). Attach documents, fields, and recipients afterwards via the wizard or the document/annotation endpoints.
  • Fully populated (include documents): creates a complete, ready-to-use template in one request — documents, role slots (recipients), and field placements (fields) are all persisted together. Documents are base64-encoded inline. Populated templates are created with SEQUENTIAL signing order; the type field is ignored on this path.

The response always returns the template summary. Call GET /v1/sign/templates/{id} afterwards for the full detail (documents, fields, default recipients).

Request​

Responses​

Template created

Response Headers
    X-Request-Id

    Correlation id for this request, returned on every response (success and error). Quote it when contacting support to pinpoint the exact request, and use it to correlate your own logs. It is the same 128-bit id as the trace-id segment of the traceparent header.

    traceparent

    W3C Trace Context identifier for this request, returned on every response. Send your own traceparent on a request to have it adopted, so a multi-call workflow shares one trace. Format: 00-<32-hex trace-id>-<16-hex span-id>-<2-hex flags>.