Metadata

For certain resource types, there may be the need to associate data with a given resource that cannot be done using the readily available fields. To address this, some resources allow the client to attach key/value data using the metadata field.

Resources that support metadata will have the metadata field listed in their documentation, along with any resource specific behaviour that may be associated with certain keys (eg. in the case of addresses, the contact_phone_number is checked to ensure that it is an E.164 formatted number).

Each resource allows up to 50 key/value pairs to be stored.

Keys may include alphanumeric characters and underscores, and may be up to 50 characters in length. Values may include any UTF-8 text, and may be up to 500 characters in length.