Get help on Discord

Setting initial values for reference fields in Sanity schema.

8 replies
Last updated: Mar 4, 2021
Hello! Is it possible to define an Inital Value for a type: "reference". Let's say for the reference to the author of a post, so in the output the name of the author will be: "". How would I do that?
AI Update

Yes, absolutely! You can set initial values for reference fields in Sanity. There are two main approaches depending on your needs:

1. Field-Level Initial Value (Simple)

For a straightforward default reference that applies every time a document is created, add initialValue directly to your schema field:

defineField({
  name: 'author',
  type: 'reference',
  to: [{type: 'author'}],
  initialValue: {
    _type: 'reference',
    _ref: 'your-default-author-id-here'
  }
})

This will pre-populate the author field with the specified reference whenever someone creates a new post.

2. Initial Value Templates (Dynamic/Contextual)

For more sophisticated scenarios—like automatically setting the author to the current user—use Initial Value Templates in your sanity.config.ts:

// sanity.config.ts
export default defineConfig({
  // ... other config
  document: {
    newDocumentOptions: (prev, context) => {
      return [
        ...prev,
        {
          id: 'post-with-author',
          title: 'Post',
          schemaType: 'post',
          value: async (params, context) => {
            // Get current user
            const {id} = context.currentUser
            
            // Find corresponding author document
            const client = context.getClient({apiVersion: '2024-11-01'})
            const author = await client.fetch(
              `*[_type == "author" && userId == $userId][0]._id`,
              {userId: id}
            )
            
            return {
              author: {
                _type: 'reference',
                _ref: author
              }
            }
          }
        }
      ]
    }
  }
})

This approach lets you:

  • Set the author based on who's logged in
  • Pass parameters to customize the initial value
  • Fetch data from your content lake or external APIs
  • Create multiple document creation options for the same type

The template-based approach is particularly powerful when combined with the Structure Builder for creating contextual workflows, like automatically linking child documents to their parent.

Both methods work great—use field-level initialValue for static defaults, and Initial Value Templates when you need dynamic or user-specific values!

I don't know about defining it as an initial value, but you could achieve something like this in your query:
*[_type == "post"]{
  ...,
  "author": select(
    defined(authorRef) => authorRef -> name,
    ""
  )
}
Well, it should be defined in the schema, because if there is no value set in the studio, there is no author in the query and this will give an arror of undefined.
That's what I mean - the query above would skit around that by always returning something for the author, even if none is set.
For your solution, it feels like maybe you need to create a "default" dummy author to set in your initial value template
Hi Pieter, is this always the same value or should it come from a query? i.e. should it set the reference to a default author? Not sure I fully get the 
""
part of the original post 🙂 Thanks for clarifying.
Yes ok, sorry. Let me be more clear about this. My problem is: in Studio leaving the Author (type: "reference") field of a Post empty will cause an error of "undefined" in the output, because there will be no Author object. My question is: Is it possible in a schema to define an empty value as Inital Value for a type: "reference". In this case for the reference to the author of a post, so in the output the name of the author will be: "", instead of "undefined". Or is there another way to counter this problem?
Thanks for explaining! It's possible to set an initial value for a reference field, but that's intended for cases where you want to actually set a default author, not to get an empty string as a query response.
In this situation, I would follow djeglin's suggestion to handle it on the query side instead
or in the front-end code itself.
On the query side, you could use the above suggestion or, alternatively, the 
coalesce()
function to set a default value (however, note that an empty string doesn't work here). Example:
// Default values when missing or null in document

*[_type == 'movie']{..., 'rating': coalesce(rating, 'unknown')}
To handle it outside of the query, you could consider checking for the existence of the author object wherever you include it: e.g. 
{author && author.name}
.
The same applies if the issue is on the studio side instead, for example in previews. Does this help?
Certainly, thanks Peter, thanks djeglin!

Sanity – Build the way you think, not the way your CMS thinks

Sanity is the developer-first content operating system that gives you complete control. Schema-as-code, GROQ queries, and real-time APIs mean no more workarounds or waiting for deployments. Free to start, scale as you grow.

Get started for freeExplore the demo

Was this answer helpful?