Dropbox Sign Developer Documentation

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

have the same or higher page count
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.

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](https://app.hellosign.com/api/eventsAndCallbacksWalkthrough).

Authentication

AuthorizationBasic

Basic authentication of the form Basic <username:password>.

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

template_idstringRequired

The ID of the template whose files to update.

Request

This endpoint expects an object.

client_idstringOptional

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

fileslist of stringsOptional

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

This endpoint requires either files or file_urls[], but not both.

file_urlslist of stringsOptional

Use file_urls[] to have Dropbox Sign download the file(s) to use for the template.

This endpoint requires either files or file_urls[], but not both.

messagestringOptional<=5000 characters

The new default template email message.

subjectstringOptional<=100 characters

The new default template email subject.

test_modebooleanOptionalDefaults to 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.

Response headers

X-RateLimit-Limitinteger

The maximum number of requests per hour that you can make.

X-RateLimit-Remaininginteger

The number of requests remaining in the current rate limit window.

X-Ratelimit-Resetinteger

The Unix time at which the rate limit will reset to its maximum.

Response

successful operation

templateobject

Contains template id

Errors

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

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

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

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

1	import json
2	from datetime import date, datetime
3	from pprint import pprint
4
5	from dropbox_sign import ApiClient, ApiException, Configuration, api, models
6
7	configuration = Configuration(
8	username="YOUR_API_KEY",
9	# access_token="YOUR_ACCESS_TOKEN",
10	)
11
12	with ApiClient(configuration) as api_client:
13	template_update_files_request = models.TemplateUpdateFilesRequest(
14	files=[
15	open("./example_signature_request.pdf", "rb").read(),
16	],
17	)
18
19	try:
20	response = api.TemplateApi(api_client).template_update_files(
21	template_id="f57db65d3f933b5316d398057a36176831451a35",
22	template_update_files_request=template_update_files_request,
23	)
24
25	pprint(response)
26	except ApiException as e:
27	print("Exception when calling TemplateApi#template_update_files: %s\n" % e)

1	{
2	"template": {
3	"template_id": "f57db65d3f933122019888057a36176831451a35"
4	}
5	}