FROM CACHE - en_header

Metafield keys: restrictions on special characters?

Shopify Partner
4 1 1


We're getting a "metafields.key must be unique within this namespace on this resource" error attempting to update metafields on a product via the REST API.

The key values are indeed unique; however, they share a common prefix that contains an "&" character. For example:

  • mumble&mumble_key1
  • mumble&mumble_key2

Is this perhaps causing the key text after the "&" (the unique part) to be ignored?

Are there special characters which should not appear in metafield keys? There is no mention of such restrictions that I have found yet in the Metafields API documentation...

Or are there perhaps key length limitations that are truncating the keys before the unique part is reached?


Replies 2 (2)
Shopify Partner
4219 304 902

Test Urlencoding the ampersands for a change in situation.

Finally Combinable Discounts - EARLY ACCESS ONLY - Use Free Shipping With Other Discounts

Answers powered by coffee Buy Paul a Coffee for more answers or donate to
Problem Solved? ✔Accept and Like solutions to help future merchants
Confused? Busy? Buy a custom solution
Shopify Partner
4 1 1

We can certainly try sanitizations, but needing something like UrlEncode() on the key value should be documented...