Last updated: May 29, 2024

<span aria-hidden="true" id="api-update-template-names-switch-to-url-safe-slugs"></span>

# API update: Template names switch to url-safe slugs

![Kevin van Zonneveld](/assets/images/teammates/avatar-kvz-4.jpg?dpl=dpl_5eQDcFwLGbzg3PfkSEW2a2j2x5pY)

**Kevin van Zonneveld**

Co-founder · Amsterdam, The Netherlands · Show bio

[](https://x.com/kvz)[](https://github.com/kvz)

We'd like to share a change to our API that we'll be making on April 30, 2020. On that day, we will change all the names that our customers have given to their Templates to a format that is URL-safe. If, for instance, your Template was previously called`Video encode for Apple Devices`, the new name will be `video-encode-for-apple-devices`.

![A news channel style logo with 'Transloadit News' as the network name, with 'Template Naming' as the headline.](/_next/static/immutable/media/opengraph-image.1uayw6rt56w2-.jpg)

This change will make it possible to start referring to Templates by this URL-safe name, which we call a slug. As a result, you will be able to create your Assemblies like this:

```json
{
  "params": {
    "template_id": "video-encode-for-apple-devices"
  }
}

```

instead of only by their ID, like before:

```json
{
  "params": {
    "template_id": "a528022861cf4a0292ea96bd2b18efc1"
  }
}

```

This makes Assembly Instructions more self-explanatory right inside your code editor, and it can help avoid mistakes that are easily overlooked when using UUIDv4 without dashes like`a528022861cf4a0292ea96bd2b18efc1`. We also have a, still secret, feature in the making that will benefit greatly from being able to refer to Templates by their slug. Stay tuned!

Of course, as with any change, there is a trade-off: if you start adopting Templateslugs, it does mean that you cannot change that name (read: slug) without breaking your integrations. This should either be done carefully, or – if this is problematic for your usecase – just continue referring to Template IDs as you already do. No changes needed.

<span aria-hidden="true" id="is-converting-names-to-slugs-backwards-compatible"></span>

## Is converting names to slugs backwards compatible?

We do not expect any breakage from the migration since, until that point, the human-readableTemplate names (`Video encode for Apple Devices`) should have only been used by, well, humans. Transloadit does not offer any functionality based on these names, besides displaying them in lists and letting humans search on them. This will continue to work after the migration. Type:`apple`, and you'll get `video-encode-for-apple-devices`, just like you would have gotten`Video encode for Apple Devices` in your search results.

The only thing that could break is if, in your own automation code, you are relying onTemplate names somehow. If this is the case for you, we recommend changing this before April 30, 2020 to avoid any breakage. Best not rely on names at all, and use IDs in your own code instead if you want to ensure things will work forever.

[#company](/blog/tags/company.md)[#api](/blog/tags/api.md)

### 👩‍💻 Join 20k+ developers

Sign up for our [monthly newsletter](/newsletters.md) to receive direct links to 3 exclusive tech — and 2 product updates. No less, no more.

Your email:

Get access

## File uploading and encoding. Made simple.

Transloadit streamlines file handling for developers, trusted by brands like Coursera and The New York Times. We’re known for a reliable API, top-notch support, and a strong commitment to open source, with projects like [Uppy⁠](https://uppy.io) and [Tus⁠](https://tus.io) setting standards in file processing.

[Sign up](/c/)[Book a Demo](https://survey.typeform.com/to/kRg47Xi5)

No credit card needed

Cancel anytime
