Guidelines for Naming Metaproperty and Metaproperty Options

When you create a name, a metaproperty, or its option, a label and database names are automatically generated. 

It is important to note that once a metaproperty or option is saved, the database name becomes permanent and cannot be altered. However, the label name can still be updated if needed.

Guidelines for Metaproperty Database Name

  • Use only alphanumeric characters (A-Z, a-z, 0-9), hyphens (-), ampersands (&), underscores (_), and periods (.).
  • Any unsupported character will automatically be replaced with an underscore (_).
  • Hyphens (-) cannot be the final character in a name; if they are, they will be converted to an underscore (_).
  • The database name must be unique. If a duplicate name is found (e.g., from another metaproperty or option), a numeric suffix (_1, _2, etc.) is added to ensure uniqueness.
  • The database name is fixed at the time of creation. Future updates to the metaproperty name in the taxonomy will not affect the database name.

Recommendation for Integrations

  • Avoid relying on the database name for integrations due to its restrictions and immutability.
  • Use the externalReference field instead. This field supports customer-specific logic, has no character restrictions, and can be updated to align with integration requirements.

FAQ

Where can I find the database name?

The database name is visible only to those who have managed metaproperty permission. It appears in the metaproperty details under the metaproperty management section.

Can I change the name of the database name?

No, after naming your metaproperty or metaproperty option, the database name becomes permanent and cannot be altered. However, you can change the label's name.  

Screenshot 2024-11-18 at 2.52.14 PM.png

For example, if you created the meta property "city" but wanted to change it to display "the city," you can edit the meta property name; however, the database name does not reflect the updated name. 

Can I add a special character to a metaproperty name label?

Yes, special characters are allowed in the metaproperty name label.

Updated

Was this article helpful?

0 out of 0 found this helpful

We're sorry to hear that!

Find out more in our community

Need more help? Post your question in our community