Skip to main content

Message metadata overview

Message metadata allows you to add status indicators (key-value pairs) to sent messages. APIs are available to set, delete, and query metadata.

Use cases​

Any scenario that requires adding status labels to messages in direct or group channels can use message metadata. Examples:

  • Message reactions/comments: Add comment data as metadata on the original message.
  • Status changes: Track gift redemption, order status updates, etc. For example, send a gift message with a default "unclaimed" status, then update the metadata to "claimed" when the user taps it.
tip

Message metadata APIs support direct and group channels only.

Metadata storage​

Metadata operations generate "metadata operation messages." Cloud message storage is enabled by default for direct and group channels, so metadata operation messages are stored for 6 months and can be retrieved via the history API at any time.

Last updated on