Edit a Document's Unique Identifier (UID)

The Prismic editor has a special field called the "UID" field. UID stands for "unique identifier."

The Prismic editor has a special field called the “UID” field. UID stands for “unique identifier.” The UID is often (though not always) used to set a document’s URL. UIDs are automatically formatted to be URL-friendly.

UIDs are unique. Prismic ensures that no two documents with the same custom type have the same UID. Even if you change a document’s UID, you can not use the old UID on another document unless you delete the original document.

What if I need to use a UID that has previously been used?

Let’s say you have an old UID value called old-uid that you wish to reuse on another document. To reassign it, duplicate the document associated with old-uid and delete the document’s original version.

If you don’t know which document is storing old-uid, navigate to your API browser (replace your-repo-name with your repository’s name):

https://your-repo-name.prismic.io/api/v2

Enter the following into the query field, making sure to add the correct custom type ID and replace old-uid with the value you’re looking for:

[at(my.your-custom-type.uid, "old-uid")]

The document associated with old-uid will be returned.

Find this document in the Page Builder. Duplicate it, then delete its original version. You’ll now be able to reuse old-uid.

When you enter text in the UID field, Prismic will automatically format it and check to see if it’s unique. If you don’t fill it manually, the UID will automatically populate with text from another text field.