Update Template

put

https://www.signwell.com/api/v1/document_templates/{id}

Updates an existing template.

Path Params

uuid

required

Unique identifier for a template. A template that carries a pre-applied signature or initials field cannot be used while 21 CFR Part 11 is enabled, which requires every signature to be signed by the recipient: it returns a 422.

Body Params

name

string

The name of the template.

subject

string

Email subject for the signature request that recipients will see. Defaults to the default system subject or a template subject (if the document is created from a template). Applies to email notifications only; SMS notifications always use fixed system templates.

message

string

Email message for the signature request that recipients will see. Defaults to the default system message or a template message (if the document is created from a template). Applies to email notifications only; SMS notifications always use fixed system templates.

draft

boolean

Defaults to false

Whether the template can still be updated before it is ready for usage. If set to false the template is marked as Available and it will be ready for use. Defaults to false.

expires_in

integer

≥ 1

Number of days before the signature request expires. Defaults to the account expiration setting or template expiration (if the document is created from a template).

reminders

boolean

Defaults to true

Whether to send signing reminders to recipients. Reminders are sent on day 3, day 6, and day 10 if set to true. Defaults to true.

apply_signing_order

boolean

Defaults to false

When set to true recipients will sign one at a time in the order of the recipients collection of this request.

api_application_id

uuid

Unique identifier for API Application settings to use. API Applications are optional and mainly used when isolating OAuth apps or for more control over embedded API settings

redirect_url

url

A URL that recipients are redirected to after successfully signing a document.

allow_decline

boolean

Defaults to true

Whether to allow recipients the option to decline signing a document. If multiple signers are involved in a document, any single recipient can cancel the entire document signing process by declining to sign.

allow_reassign

boolean

Defaults to true

In some cases a signer is not the right person to sign and may need to reassign their signing responsibilities to another person. This feature allows them to reassign the document to someone else. Unavailable on 21 CFR Part 11 documents: omit it and reassignment stays off, while sending true returns a 422.

decline_redirect_url

url

A URL that recipients are redirected to if the document is declined.

conditional_rules

array of objects

Conditional logic rules that show, hide, or require fields based on what a signer does to other fields. Every identifier is a field api_id. At most 10 rules per document or template.

conditional_rules

metadata

object

Optional key-value data that can be associated with the document. If set, will be available every time the document data is returned.

labels

array of objects

Labels can be used to organize documents in a way that can make it easy to find using the document search in SignWell. A document can have multiple labels. Updating labels on a document will replace any existing labels for that document.

labels

checkbox_groups

array of objects

Checkbox fields that are placed on a document can be grouped with selection requirements. At least 2 checkbox fields in an array of fields must be assigned to the same recipient.

checkbox_groups

Responses

200ok

400bad request

422unprocessable entity

429rate limit exceeded