Update Template Files

post/template/update_files/{template_id}

Overlays a new file with the overlay of an existing template. The new file(s) must:

  1. have the same or higher page count
  2. the same orientation as the file(s) being replaced.

This will not overwrite or in any way affect the existing template. Both the existing template and new template will be available for use after executing this endpoint. Also note that this will decrement your template quota.

Overlaying new files is asynchronous and a successful call to this endpoint will return 200 OK response if the request passes initial validation checks.

It is recommended that a callback be implemented to listen for the callback event. A template_created event will be sent when the files are updated or a template_error event will be sent if there was a problem while updating the files. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the API dashboard and retry the request if necessary.

If the page orientation or page count is different from the original template document, we will notify you with a template_error callback event.

Securityapi_key or oauth2
Request
path Parameters
template_id
required
string

The ID of the template whose files to update.

Example: f57db65d3f933b5316d398057a36176831451a35
Request Body schema:
client_id
string

Client id of the app you're using to update this template.

file
Array of strings <binary>

Use file[] to indicate the uploaded file(s) to use for the template.

This endpoint requires either file or file_url[], but not both.

file_url
Array of strings

Use file_url[] to have HelloSign download the file(s) to use for the template.

This endpoint requires either file or file_url[], but not both.

message
string <= 5000 characters

The new default template email message.

subject
string <= 100 characters

The new default template email subject.

test_mode
boolean
Default: false

Whether this is a test, the signature request created from this draft will not be legally binding if set to true. Defaults to false.

Responses
200

successful operation

4XX

failed_operation

Request samples
Response samples
application/json
{
  • "template": {
    }
}