Skip to main content
Anchor to MetafieldDefinitionDeletePayload

MetafieldDefinitionDeletePayload

payload

Return type for the metafieldDefinitionDelete mutation.

Anchor to FieldsFields

Anchor to deletedDefinitiondeletedDefinition
•MetafieldDefinition
Anchor to userErrorsuserErrors
•[UserError!]!
non-null

List of errors that occured while executing the mutation.

Was this section helpful?

Anchor to Mutations with this payloadMutations with this payload

Anchor to metafieldDefinitionDeletemetafieldDefinitionDelete
•mutation

Remove a MetafieldDefinition and cascade delete all associated Metafields.

Arguments

Anchor to identifieridentifier
•CustomDataKeyPairInput!
required

This argument accepts an object that consists of a key and an optional namespace. The key is a mandatory attribute that represents a specific element within a namespace. The namespace attribute, if provided, should be a period-delimited string representing the hierarchical path to the desired definition. This is applicable in cases where the desired definition is nested within namespaces. In the absence of a provided namespace, the system will default to the client's implicit, reserved namespace.

Was this section helpful?