Metadata

Some endpoints in the API will allow you to store additional meta data against a resource. This data is not used to complete processing, but will be returned back to the caller when the resource is requested.

The meta data is accepted and stored as key:value pairs. There is a generous limit to the size of the data that can be stored. A key can be up to 250 characters, and a value can be up to 255 characters.

Metadata keys are always cast to lower case in the AIR platfrom. Any keys passed in in camelCase will end up getting converted to lowercase (camelcase). It is advised that calling applications always send in lower case keys so request and response are consistent.

An example of some meta data for a consumer record is:

"meta": {
    "nationality": "british",
    "gender": "male",
    "preferredcontact": "SMS",
    "signup": "2000-10-01"
  }

When updating a resource where there is the ability to store meta data, the value of any key can be updated by passing in the key and a new value. To delete the meta data record, the resource should be updated with the key and an empty value. It can be re-instated by passing the key and a value back in a subsequent update.