Developer Overview
Metadata
3min
We support including metadata on most of our resources as a way to add internal information to our system. Metadata takes the form of free-form key-value pairs. This allows easier searching through both the API and web interfaces.
You may write metadata both when you create an object and when updating the object.
If you would like to remove metadata that is already on an object, you can unset it by passing in the key-value pair with an empty string or null as the value, like this:
Some endpoints such as List and GET api's allow you to query for objects via metadata. Refer to each api for additional details
Updated 04 Aug 2023
Did this page help you?