Metadata is data that provides information about other data.

Within Gigs, metadata is used to store information (or values) on Gigs resources and organize them in different categories (or keys). Metadata is available on the following Gigs resources:

• Users

• Subscriptions

• SIMs

• Devices

• Plans

A key can be thought of as a category or label for a value .

Example:

• key external_customer_id

• value ext_123abc

For more technical information, see our API Documentation as an example of adding metadata to a subscription.

Anyone with access to the Dashboard can see available metadata entries on an individual resource page.

For example: an individual subscription page below, with metadata highlighted in the bottom left corner.

Those with Dashboard edit access can edit keys and values by clicking on "Edit". This will open a slide over where you can add/delete fields and edit existing fields.

• There is a maximum of 10 items per resource

• A key cannot be empty; a value can be empty

• A key's maximum length is 40 characters; a value’s maximum length is 255 characters

• Emojis cannot be used in keys and values

Metadata can be used for many things, such as:

• Associating a customer-specific internal ID with a Gigs resource

• Notating subscriptions activated via different channels

If you want to implement metadata but you're not sure how, reach out to [email protected] for help.