Represents a tag defined on a chat. Tags let you group users or route messages to a subset of a group or channel.

💡 Tags are scoped to the chat they were created in — up to 63 per chat — and are not shared across chats.

Fields

Field Type Required Description
id String Yes The tag. Sent on the wire as a number; the SDKs expose it as a string.
name String Optional Display name.
description String Optional What the tag is for.
isPrivate Integer Optional 1 if the tag is private, 0 if it is public. Sent on the wire as a boolean; the SDKs normalise it to 1/0.

Example

{
  "id": 0,
  "name": "Manager",
  "description": "Manager Tag",
  "isPrivate": true
}