Metadata

We offer support for adding metadata to most of our resources, allowing you to include internal information within our system. Metadata consists of flexible key-value pairs, enabling easier searches via both the API and web interfaces. Organizations can also create specific rules based on these metadata values. Metadata can be added during object creation or updated later.

To remove existing metadata from an object, you can unset it by passing the key-value pair with an empty string or null as the value, as shown below:

JSON

{
  "key-to-delete": ""
}

// OR

{
  "key-to-delete": null
}

Metadata Example

{
  "Customer ID": "5584"
}