Skip to main content
Anchor to MetafieldDefinitionUpdateInput

MetafieldDefinitionUpdateInput

input_object

Set of inputs to the metafieldDefinitionUpdate Mutation.

•CustomDataAccessInput

Optional AccessGrants that can be created along with the definition. Sharing requires additional client scope and is not available to all clients.

•String

Human friendly description of the Definition.

•CustomDataKeyPairInput!
required

Key and namespace pair that together form the path to the definition. Key is required, Namespace defaults to the Client's implicit, reserved namespace if not provided.

•String

Use 'key' to provide a new key if desired. Only changes the key for the Client's own use, or if accessed through a Namespace with Admin permission on the Primitive, will change the key within the Namespace.

•String

Human friendly display name.

•[CustomDataMetafieldDefinitionValidationInput!]

Optional validations on the value in a field. Changes will be enforced upon the next use of metafieldSet for this definition on a given user.


Was this section helpful?