Update template

put

https://api.signeasy.com/v3/template/{template_id}

Change a template's name, message, roles, fields, and merge fields. is_ordered and roles are required on every call.

Update an uploaded or existing template's name, message, roles, fields, and merge fields.

You can also use this endpoint to pre-configure a template before you embed the template to complete the setup using the fetch embedded template create URL endpoint.

Pre-fill by Sender or Earlier Signers
Make a text, checkbox, or combobox field pre-fillable by giving it a label and a fillable_by. For pre-fill by sender, set fillable_by.sender to true, then pass the value in merge_fields using that label when you send from the template. For pre-fill by earlier signers, list the roles in fillable_by.roles and set is_ordered to true. Both are available only on the API Advanced Plan. Merge fields for templates (the merge_fields array on this endpoint) stay available on all API plans. Reach support or sales for more details.

Path Params

template_id

int32

required

Body Params

name

string

Defaults to Sample Template Name

The name of the source document. As a security measure the /, :, *, , <, >, | characters are not allowed in the name property in the API request.

is_ordered

boolean

required

Defaults to true

When set to true the recipients will sign the documents in the specified order. Must be true when a field's fillable_by.roles lets an earlier role pre-fill it.

roles

array of objects

required

A collection of role objects to specify the role related metadata for the signer(s).

roles*

fields_payload

array of objects

Programmatically place fields on the documents based on x-y coordinates or a reference text.

fields_payload

merge_fields

array of objects

Merge fields for templates. Place text fields that only the sender fills when sending from the template. They don't belong to any role. Available on all API plans. For a field that a role owns and can still edit, use pre-fill by sender instead (label and fillable_by in fields_payload).

merge_fields

message

string

Defaults to This is a test message

The message you provide here will be displayed in the signing interface to the signers along with the document.

Responses

Language

Credentials

Bearer

Loading…

Response

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

application/json

Update template

Pre-fill by Sender or Earlier Signers

Next

Next

Pre-fill by Sender or Earlier Signers

200200

400The body fails validation

401Invalid access token, or the template doesn't exist or isn't yours

Next

Next