SignEnvoy docs
Sign in Start in the sandbox

API reference Templates

API reference

Templates

GET /v1/templates

List Templates

D46(f): the CLI's `template list`. D89: `folder` narrows to one folder.

Query

  • limit integer (>= 1, <= 200) default 50
  • offset integer (>= 0, <= 9223372036854776000) default 0
  • folder string (uuid) | null. Templates in this template folder only (not its subfolders).

Responses

  • 200 TemplatePage (application/json): Successful Response
  • 401 ProblemDetails (application/problem+json): /problems/unauthenticated
  • 402 ProblemDetails (application/problem+json): /problems/live-mode-unavailable
  • 403 ProblemDetails (application/problem+json): Workspace entitlement or access denied.
  • 422 ProblemDetails (application/problem+json): Request schema or semantic validation failed; inspect type and detail.
  • 429 ProblemDetails (application/problem+json): /problems/rate-limited; retry after Retry-After seconds.
  • 500 ProblemDetails (application/problem+json): /problems/engine-error
  • default ProblemDetails (application/problem+json): API error; type identifies the stable problem.

Problem types and recovery steps: error reference.

POST /v1/templates

Create Template

Request body (application/json, required)

MemberTypeNotes
fields array of FieldSpec FieldSpec
folder_id string (uuid) | null A template folder of this workspace (`GET /folders?kind=templates`). A document folder is refused.
name required string (min length 1, max length 300)
pdf_base64 required string
recipients array of RecipientSpec RecipientSpec

Responses

  • 201 TemplateOut (application/json): Successful Response
  • 401 ProblemDetails (application/problem+json): /problems/unauthenticated
  • 402 ProblemDetails (application/problem+json): /problems/live-mode-unavailable
  • 403 ProblemDetails (application/problem+json): Workspace entitlement or access denied.
  • 409 ProblemDetails (application/problem+json): Invalid state, conflict, or idempotency key conflict.
  • 422 ProblemDetails (application/problem+json): Request schema or semantic validation failed; inspect type and detail.
  • 429 ProblemDetails (application/problem+json): /problems/rate-limited; retry after Retry-After seconds.
  • 500 ProblemDetails (application/problem+json): /problems/engine-error
  • default ProblemDetails (application/problem+json): API error; type identifies the stable problem.

Problem types and recovery steps: error reference.

GET /v1/templates/{tpl_id}

Get Template

D46(f): the CLI's `template pull` — the definition round-trips.

Path

  • tpl_id string

Responses

  • 200 TemplateOut (application/json): Successful Response
  • 401 ProblemDetails (application/problem+json): /problems/unauthenticated
  • 402 ProblemDetails (application/problem+json): /problems/live-mode-unavailable
  • 403 ProblemDetails (application/problem+json): Workspace entitlement or access denied.
  • 404 ProblemDetails (application/problem+json): Resource not found or not accessible to this key.
  • 422 ProblemDetails (application/problem+json): Request schema or semantic validation failed; inspect type and detail.
  • 429 ProblemDetails (application/problem+json): /problems/rate-limited; retry after Retry-After seconds.
  • 500 ProblemDetails (application/problem+json): /problems/engine-error
  • default ProblemDetails (application/problem+json): API error; type identifies the stable problem.

Problem types and recovery steps: error reference.

PATCH /v1/templates/{tpl_id}

Patch Template

D54/TE-6: replaces the parts given and bumps `version`. Documents already created from the template are unaffected.

Path

  • tpl_id string

Request body (application/json, required)

MemberTypeNotes
clear_folder boolean Take the template out of its folder. Default false.
fields array of FieldSpec | null FieldSpec
folder_id string (uuid) | null Move the template into this template folder.
name string (min length 1, max length 300) | null
recipients array of RecipientSpec | null RecipientSpec

Responses

  • 200 TemplateOut (application/json): Successful Response
  • 401 ProblemDetails (application/problem+json): /problems/unauthenticated
  • 402 ProblemDetails (application/problem+json): /problems/live-mode-unavailable
  • 403 ProblemDetails (application/problem+json): Workspace entitlement or access denied.
  • 404 ProblemDetails (application/problem+json): Resource not found or not accessible to this key.
  • 422 ProblemDetails (application/problem+json): Request schema or semantic validation failed; inspect type and detail.
  • 429 ProblemDetails (application/problem+json): /problems/rate-limited; retry after Retry-After seconds.
  • 500 ProblemDetails (application/problem+json): /problems/engine-error
  • default ProblemDetails (application/problem+json): API error; type identifies the stable problem.

Problem types and recovery steps: error reference.

DELETE /v1/templates/{tpl_id}

Delete Template

D54: soft delete — the template disappears from list/get/use; documents created from it are unaffected.

Path

  • tpl_id string

Responses

  • 204 no body: Successful Response
  • 401 ProblemDetails (application/problem+json): /problems/unauthenticated
  • 402 ProblemDetails (application/problem+json): /problems/live-mode-unavailable
  • 403 ProblemDetails (application/problem+json): Workspace entitlement or access denied.
  • 404 ProblemDetails (application/problem+json): Resource not found or not accessible to this key.
  • 422 ProblemDetails (application/problem+json): Request schema or semantic validation failed; inspect type and detail.
  • 429 ProblemDetails (application/problem+json): /problems/rate-limited; retry after Retry-After seconds.
  • 500 ProblemDetails (application/problem+json): /problems/engine-error
  • default ProblemDetails (application/problem+json): API error; type identifies the stable problem.

Problem types and recovery steps: error reference.

POST /v1/templates/{tpl_id}/duplicate

Duplicate Template

T-5: a new template (version 1) from the same PDF and definition.

Path

  • tpl_id string

Request body (application/json)

Type: DuplicateTemplateIn | null

Responses

  • 201 TemplateOut (application/json): Successful Response
  • 401 ProblemDetails (application/problem+json): /problems/unauthenticated
  • 402 ProblemDetails (application/problem+json): /problems/live-mode-unavailable
  • 403 ProblemDetails (application/problem+json): Workspace entitlement or access denied.
  • 404 ProblemDetails (application/problem+json): Resource not found or not accessible to this key.
  • 409 ProblemDetails (application/problem+json): Invalid state, conflict, or idempotency key conflict.
  • 422 ProblemDetails (application/problem+json): Request schema or semantic validation failed; inspect type and detail.
  • 429 ProblemDetails (application/problem+json): /problems/rate-limited; retry after Retry-After seconds.
  • 500 ProblemDetails (application/problem+json): /problems/engine-error
  • default ProblemDetails (application/problem+json): API error; type identifies the stable problem.

Problem types and recovery steps: error reference.

POST /v1/templates/{tpl_id}/use

Use Template

Path

  • tpl_id string

Request body (application/json, required)

MemberTypeNotes
date_format "YYYY-MM-DD" | "MM/DD/YYYY" | "DD/MM/YYYY" | "D MMM YYYY" | null How date fields are written into the signed PDF. One of the listed values; any other value is a 422.
display_timezone string | null IANA time zone name used to show dates and times to signers and on the Certificate of Completion, such as `America/New_York` or `UTC`. Matched exactly, including case. Display only: storage is UTC. Any other value is a 422.
form_values object of string Prefill values keyed by field name, or by field index as a string in the template's field order ("0", "1", …). An unknown key fails the request with 422.
recipients required array of RecipientSpec RecipientSpec
redirect_url string | null Where the signer is sent after finishing. Must be an `https://` URL (D20); anything else is a 422 here, not a failure later.
title string (min length 1, max length 300) | null

Responses

  • 201 DocumentOut (application/json): Successful Response
  • 401 ProblemDetails (application/problem+json): /problems/unauthenticated
  • 402 ProblemDetails (application/problem+json): /problems/live-mode-unavailable
  • 403 ProblemDetails (application/problem+json): Workspace entitlement or access denied.
  • 404 ProblemDetails (application/problem+json): Resource not found or not accessible to this key.
  • 409 ProblemDetails (application/problem+json): Invalid state, conflict, or idempotency key conflict.
  • 422 ProblemDetails (application/problem+json): Request schema or semantic validation failed; inspect type and detail.
  • 429 ProblemDetails (application/problem+json): /problems/rate-limited; retry after Retry-After seconds.
  • 500 ProblemDetails (application/problem+json): /problems/engine-error
  • default ProblemDetails (application/problem+json): API error; type identifies the stable problem.

Problem types and recovery steps: error reference.