Flag of Ukraine

Edit a Template

PUT https://api2.transloadit.com/templates/{TEMPLATE_ID}

Updates the Template represented by TEMPLATE_ID with the new Template name and Template JSON.

PUT fields

  • Passing signature is required. For more information please check Signature Authentication.
  • Passing params is required. It should contain a JSON encoded object with the keys as shown in the table below.

Supported keys inside the params field

  • auth

    Object required

    Contains at least your Transloadit Auth Key in the key property.

    If you enable Signature Authentication, you'll also set an expiry date for the request in the expires property like so:

    {
      "key": "23c96d084c744219a2ce156772ec3211",
      "expires": "2022/01/01 16:53:14+00:00"
    }
    

    The referer property is a regular expression to match against the HTTP referer of this upload, such as "example\.org". Specify this key to make sure that uploads only come from your domain.

    Uploads without a referer will always pass (as they are turned off for some browsers) making this useful in just a handful of use cases. For details about regular expressions, see Mozilla's RegExp documentation.

    The max_size property can be used to set a maximum size that an upload can have in bytes, such as 1048576 (1 MB). Specify this to prevent users from uploading excessively large files.

    When using this key, make sure that it is specified as a hidden max_size form field, since setting max_size in a Template will have no effect.

    The file size is checked as soon as the upload is started and if it exceeds the maximum size, the entire upload process is canceled and the Assembly will error out, even if it contains files that do not exceed the max_size limitation.

    If you want to just ignore the files that exceed a certain size, but process all others, then please use our /file/filter Robot.

  • name

    String ⋅ default: Existing name

    Name of this Template. Must be between 5-40 symbols (inclusive), lowercase, can only contain dashes and latin letters.

  • template

    String ⋅ default: Existing template

    All the new Assembly Instructions as a JSON encoded string.

  • require_signature_auth

    Integer ⋅ default: Existing require_signature_auth

    Use 1 to deny requests that do not include a signature. With Signature Authentication you can ensure no one else is sending requests on your behalf.

Response

Here’s an example response body:

Upon error, the error key will contain the corresponding error status code.

Uppy
20% off any plan for the Uppy community
Use the UPPY20 code when upgrading.
Sign up
tus
20% off any plan for the tus community
Use the TUS20 code when upgrading.
Sign up
Product Hunt
20% off any plan for Product Hunters
Use the PRH20 code when upgrading.
Sign up