Update a document template

patch

https://api.wingspan.app/v3/compliance/document-templates/{templateId}

Updates the mutable fields of a DocumentTemplate. Only the fields supplied are changed.

fileId and signerRoles are not updatable — the e-signature provider builds its own template from both at create. Set status: Inactive to archive a template, which is the retirement path for one DELETE refuses.

A template owned by another account is 404, not 403.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

templateId

string

required

Unique identifier of the document template

Body Params

Patch body for a DocumentTemplate. Only the fields supplied are changed.

fileId and signerRoles are absent on purpose and are NOT updatable: the e-signature provider builds its own template from both when this resource is created, so changing either here would leave the resource disagreeing with the document a signer is actually shown. Point at a different document by creating a new template.

Editing the document body or where its fields sit is done in the provider's embedded editor at editUrl, not through this API.

title

string

status

string

enum

Set Inactive to archive the template. This is the retirement path for a template DELETE refuses — which is any template a signature request has ever been opened against. Archiving does not affect requirement definitions already bound to the template: they keep resolving it.

Allowed:

externalId

string

Caller-supplied reconciliation id, unique per account. A duplicate returns 409 ResourceConflict.

metadata

object

Free-form key-value pairs. Max 50 keys; key length at most 40 characters; value length at most 500 characters. Where a list endpoint declares metadata filtering, it uses the QueryQL namespace via filter[metadata.{key}][eq]=value or filter[metadata.{key}][in][]=value. Endpoints that do not declare the dynamic Metadata filter do not support Metadata filtering.

Headers

Idempotency-Key

string

length between 1 and 255

^[\x21-\x7e]{1,255}$

Optional idempotency token for authenticated POST and PATCH requests. Reusing the same key and body returns the cached response for 24 hours, except credential operations that explicitly document a 409 because one-time secret material is never cached; reusing it with a different body returns 409 IdempotencyKeyConflict. Use 1-255 printable ASCII characters.

X-Wingspan-Account

string

^(?:[A-Za-z0-9_.]{22}|[a-f0-9]{24})$

Select the Account for an Account-scoped operation. A direct ServiceAccount API key MUST supply this header, and the target must be within the ServiceAccount owner's or Authorization grant's Account boundary. A Person bearer may select an Account on which it has an active Stakeholder, and an Account session may select its bound Account (or a descendant only when the session explicitly includes descendants).

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

Credentials

Bearer

JWT

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

application/problem+json

200Updated document template

400Malformed request syntax

401Unauthenticated

403Forbidden

404Resource not found

409Conflict

422Validation error