Update Template

Update an existing template.

You can use this API endpoint to change template settings, add or remove fields in a PDF template, or update the HTML/SCSS for an HTML template.

HTTP Request

PUT https://api.docspring.com/api/v1/templates/<TEMPLATE_ID>


All template properties must be nested inside a top-level template key. For example:

  "template": {
    "name": "New Template Name"


You must send an Authorization header with the value Basic followed by base 64 encoded token_id:token_secret.

For example: Authorization: Basic dG9rZW5faWQ6dG9rZW5fc2VjcmV0Cg==

See the Authentication documentation for more information.

Update a PDF with a multipart PUT request

You can create a new PDF template by making a multipart/form-data form post, using the HTTP PUT method. The following form params are required:

  • template[document] - Your PDF file data

The following form params are optional:

  • template[name] - You can also rename the template during this request.

Example Code

// Find your API tokens here: https://app.docspring.com/api_tokens

import DocSpring from 'docspring'

var config = new DocSpring.Configuration()
config.apiTokenId = 'DOCSPRING_API_TOKEN_ID'
config.apiTokenSecret = 'DOCSPRING_API_TOKEN_SECRET'
docspring = new DocSpring.Client(config)

var template_id = 'tpl_000000000000000001'
var template_data = {
  template: {
    name: 'New Template Name',
    html: '<html><body>New HTML</html></body>',
  function (error, response) {
    if (error) throw error

results matching ""

    No results matching ""