Metadata is a flexible way to store custom information about an object (e.g. a ticket, order or attendee) that you may need for internal reference.
To add metadata to an object manually, click on the individual record, scroll to the metadata section and click Add:
Metadata is stored in a set JSON format, which looks like this: {"key":"value"}
. For instance, {"seatID":"A1"}
.
Some tips for success:
The key is the label that describes what information is being stored, e.g.
seatID
.The value is the information specific to this individual record, e.g.
A1
for this attendee's unique seat number.Both the key and value should be wrapped in quote marks and contain no spaces. You can either use camel case (
"likeThis"
) or snake case ("like_this"
). The examples in this article use camel case.Between the key and the value should be a colon (
:
).If you need to include multiple pieces of metadata, list them one per row with a comma at the end of all but the last row.
Metadata should be wrapped in curly braces (
{}
) at the very start and end.
Here's an example record with several pieces of metadata:
We also support adding metadata to records via the API, and including metadata in custom exports.