Most of our POST / PATCH API request schemas include a metadata key. This is a set of user defined key-value pairs. It may be useful in cases where you'd like to store internal identifiers or other metadata on the CaliberX platform so that is returned with future requests.
Note that when updating metadata via a PATCH request, you should always send the full metadata payload.
Limitations
Metadata is currently limited to:
- 10 keys
- No nested objects
- A maximum of 1 KB of data