---
title: PrivateMetafield - GraphQL Admin
description: >-
  Private metafields represent custom metadata that is attached to a resource.

  Private metafields are accessible only by the application that created them
  and only from the GraphQL Admin API.


  An application can create a maximum of 10 private metafields per shop
  resource.


  Private metafields are deprecated. Metafields created using a reserved
  namespace are private by default. See our guide for

  [migrating private
  metafields](https://shopify.dev/docs/apps/custom-data/metafields/migrate-private-metafields).
api_version: 2024-10
api_name: admin
type: object
api_type: graphql
source_url:
  html: 'https://shopify.dev/docs/api/admin-graphql/2024-10/objects/PrivateMetafield'
  md: >-
    https://shopify.dev/docs/api/admin-graphql/2024-10/objects/PrivateMetafield.txt
---

# Private​Metafield

object

Private metafields represent custom metadata that is attached to a resource. Private metafields are accessible only by the application that created them and only from the GraphQL Admin API.

An application can create a maximum of 10 private metafields per shop resource.

Private metafields are deprecated. Metafields created using a reserved namespace are private by default. See our guide for [migrating private metafields](https://shopify.dev/docs/apps/custom-data/metafields/migrate-private-metafields).

## Fields

* created​At

  [Date​Time!](https://shopify.dev/docs/api/admin-graphql/2024-10/scalars/DateTime)

  non-null

  The date and time when the private metafield was created.

* id

  [ID!](https://shopify.dev/docs/api/admin-graphql/2024-10/scalars/ID)

  non-null

  The ID of the private metafield.

* key

  [String!](https://shopify.dev/docs/api/admin-graphql/2024-10/scalars/String)

  non-null

  The key name of the private metafield.

* namespace

  [String!](https://shopify.dev/docs/api/admin-graphql/2024-10/scalars/String)

  non-null

  The namespace of the private metafield.

* updated​At

  [Date​Time!](https://shopify.dev/docs/api/admin-graphql/2024-10/scalars/DateTime)

  non-null

  The date and time when the private metafield was updated.

* value

  [String!](https://shopify.dev/docs/api/admin-graphql/2024-10/scalars/String)

  non-null

  The value of a private metafield.

* value​Type

  [Private​Metafield​Value​Type!](https://shopify.dev/docs/api/admin-graphql/2024-10/enums/PrivateMetafieldValueType)

  non-null

  Represents the private metafield value type.

***

## Map

### Fields and connections with this object

* <->[PrivateMetafieldConnection.nodes](https://shopify.dev/docs/api/admin-graphql/2024-10/connections/PrivateMetafieldConnection#field-nodes)
* {}[PrivateMetafieldEdge.node](https://shopify.dev/docs/api/admin-graphql/2024-10/objects/PrivateMetafieldEdge#field-node)

***

## Queries

### Deprecated queries

* [private​Metafield](https://shopify.dev/docs/api/admin-graphql/2024-10/queries/privateMetafield)

  query

  Deprecated

* [private​Metafields](https://shopify.dev/docs/api/admin-graphql/2024-10/queries/privateMetafields)

  query

  Deprecated

***

## \<?>PrivateMetafield Queries

***

## Mutations

* [private​Metafield​Upsert](https://shopify.dev/docs/api/admin-graphql/2024-10/mutations/privateMetafieldUpsert)

  mutation

  Deprecated

***

## <\~> PrivateMetafield Mutations

***

## Interfaces

* [Node](https://shopify.dev/docs/api/admin-graphql/2024-10/interfaces/Node)

  interface

***

## ||-PrivateMetafield Implements

### Implements

* ||-[Node](https://shopify.dev/docs/api/admin-graphql/2024-10/interfaces/Node)