Dropbox Sign/templateUpdateFiles

Preview only · details below

Dropbox SignDropbox Sign eSignature API

POST/template/update_files/{template_id}

Update Template Files

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).

Manage accounts, signature requests, templates, teams, bulk sends, file downloads, fax, and event callbacks through the complete Dropbox Sign v3 API; the Hub provides documentation and a local SDK/CLI only.

Request

operationId
templateUpdateFiles
Server
https://api.hellosign.com/v3
Authentication
api_key, oauth2

Request parameters

template_id

pathstringrequired

The ID of the template whose files to update.

f57db65d3f933b5316d398057a36176831451a35

Request body

TemplateUpdateFilesRequestrequired

Content-Type: application/json, multipart/form-data

Properties: client_idfilesfile_urlsmessagesubjecttest_mode

{
  "client_id": "example-client-id",
  "files": [
    {}
  ],
  "file_urls": [
    "https://example.com/resource"
  ],
  "message": "Example message",
  "subject": "Example document",
  "test_mode": false
}

Responses

200

TemplateUpdateFilesResponseapplication/json

successful operation

Properties: template

4XX

ErrorResponseapplication/json

failed_operation

Properties: error

{
  "template": {
    "template_id": "example-template-id",
    "warnings": [
      {
        "warning_name": "Example Name"
      }
    ]
  }
}