Skip to main content

updatePrivateMetadata Mutation

Updates private metadata of an object. Requires permissions to modify and to read the metadata of the object it's attached to.

Warning: never store sensitive information, including financial data such as credit card details.

updatePrivateMetadata(
  id: ID!
  input: [MetadataInput!]!
): UpdatePrivateMetadata
Details
type UpdatePrivateMetadata {
  metadataErrors: [MetadataError!]! @deprecated
  errors: [MetadataError!]!
  item: ObjectWithMetadata
}

Arguments​

id ● ID!​

ID or token (for Order and Checkout) of an object to update.

input ● [MetadataInput!]!​

Fields required to update the object's metadata.

Type​

UpdatePrivateMetadata​

Updates private metadata of an object. Requires permissions to modify and to read the metadata of the object it's attached to.

Warning: never store sensitive information, including financial data such as credit card details.