Configure the UID Field
This article explains what the UID field is and how to configure it in the Custom Type builder.
The UID field is a unique identifier used to create SEO-friendly website URLs. These are the characteristics of the UID field:
- The value is unique to the Custom Type and locale.
- It is space-free and written in lowercase, such as about-us. Spaces are replaced with dashes.
- It can't contain special characters (except hyphens and underscores).
- The Prismic development kits provide special helper functions for querying by UID.
- When a UID is changed, the old value is permanently saved, so documents can always be queries by old UIDs. (This prevents links on your website from breaking.)

Edit UIDs
To learn more about how to create and edit UIDs, see Edit a Document's Unique Identifier.

type
string (required)
Must be UID
config
object
Object for the configuration options
config.label
string
The label that shows up for the field in the entry editor
config.placeholder
string
A user-friendly placeholder for the field in the entry editor
Copy
"uid":{
"type":"UID",
"config":{
"label":"Unique ID",
"placeholder":"Enter a meaningful unique identifier..."
}
}
Copy
// API response example of a UID field
{
//...
"uid": "unique-value"
}
Was this article helpful?
Can't find what you're looking for? Spot an error in the documentation? Get in touch with us on our Community Forum or using the feedback form above.