Metadata

Onur Akpolat edited this page Oct 20, 2016 · 1 revision

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
         }
      }
   }
}
Clone this wiki locally
You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.
Press h to open a hovercard with more details.