Skip to main content

Multiple delivery keys

Release date: 6th November 2024

This release introduces a new feature to support multiple delivery keys for content items.

One use for delivery keys is to represent a URL in a content managed website. Adding support for multiple delivery keys makes it easier to manage URLs for localized versions of website pages. These URLs can be included in web page metadata to inform search engines about language and region specific variants of a page.

Supporting multiple delivery keys
Link copied!

To support multiple delivery keys we've added a new deliveryKeys property to content item metadata. You need to include this property in your content type schemas as described in the delivery key developer guide.

We've also included a new schema example that demonstrates how to make use of the new feature.

The Content Delivery API has also been updated to support multiple delivery keys. You can retrieve a content item using any one of its delivery keys and all of the delivery keys will be returned in the JSON response.

Multiple delivery keys- example
Link copied!

An example of a content item that supports multiple delivery keys is shown below. It's for the shoes section of a website with localized delivery keys for English, French, German and Italian. URLs representing each locale are shown in the meta section of the content form.

These URLs could be used to build the hreflang element in the shoes website page to improve the website SEO for different languages and regions.

A content item with multiple delivery keys

Delivery keys

Content Delivery API- Get Content by Key

hreflang element