Metadata

Most updatable DevRIFT objects have a metadata parameter. You can use this parameter to attach arbitrary key-value data to these DevRIFT objects.

You can specify up to 50 keys, with key names up to 40 characters long and values up to 500 characters long.

Metadata is useful for storing additional, structured information on an object. Your users won't see metadata unless you show it to them.

Some objects also support a description parameter. You can use the description parameter to annotate a request to the DevRIFT API—with, for example, a human-readable description like UserID=12345. Unlike metadata, description is a single string, and your users may see it (e.g., in emails DevRIFT sends on your behalf).

Don't store any sensitive information (bank details, personally identifing information, and so on) in metadata or in the description parameter.