Metadata

Some resources (Users, Events) support a specified metadata parameter.

You can use the metadata parameter to attach key-value data in JSON format. This is for useful for storing additional structured information about an object. As an example, you could store your users favorite color and corresponding unique identifiers from your system.

The metadata you specify is returned in API responses.

Metadata example

{
   "metadata":{
      "customField":"customValue",
      "anotherField":[
         1,
         2,
         3,
         4
      ],
      "subFields":{
         "anotherField":{
            "nestedFields": true
         }
      }
   }
}