Developers
Dropbox Sign DocsGet an API key
HomeAPI ReferenceSDKsContext Plugin
Template

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.

Authorization

AuthorizationBasic <token>

Your API key can be used to make calls to the Dropbox Sign API. See Authentication for more information. āœ… Supported by Try it console (calls sent in test_mode only).

In: header

Path Parameters

template_id*string

The ID of the template whose files to update.

Request Body

client_id?string

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

files?unknown

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_urls?array<string>

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.

message?string

The new default template email message.

Lengthlength <= 5000
subject?string

The new default template email subject.

Lengthlength <= 100
test_mode?boolean

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

Defaultfalse

Response Body

application/json

application/json

curl -X POST "https://example.com/template/update_files/f57db65d3f933b5316d398057a36176831451a35" \  -H "Content-Type: application/json" \  -d '{    "file_urls": [      "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1"    ]  }'
{  "template": {    "template_id": "f57db65d3f933122019888057a36176831451a35"  }}

Remove User from Template POST

Removes the specified Account's access to the specified Template.

Create Unclaimed Draft POST

Creates a new Draft that can be claimed using the claim URL. The first authenticated user to access the URL will claim the Draft and will be shown either the "Sign and send" or the "Request signature" page with the Draft loaded. Subsequent access to the claim URL will result in a 404.