ChatInviteLinkResponse

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/telegram/json-schema/telegram-chat-invite-link-response-schema.json",
  "title": "ChatInviteLinkResponse",
  "x-generated": "2026-11-06",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/telegram-invites-api-openapi.yml#/components/schemas/ChatInviteLinkResponse",
  "type": "object",
  "properties": {
    "ok": {
      "type": "boolean"
    },
    "result": {
      "$ref": "#/$defs/ChatInviteLink"
    }
  },
  "$defs": {
    "ChatInviteLink": {
      "type": "object",
      "properties": {
        "invite_link": {
          "type": "string",
          "description": "The invite link"
        },
        "creator": {
          "$ref": "#/$defs/User"
        },
        "creates_join_request": {
          "type": "boolean",
          "description": "True if users joining via the link need to be approved"
        },
        "is_primary": {
          "type": "boolean",
          "description": "True if the link is primary"
        },
        "is_revoked": {
          "type": "boolean",
          "description": "True if the link is revoked"
        },
        "name": {
          "type": "string",
          "description": "Invite link name"
        },
        "expire_date": {
          "type": "integer",
          "description": "Point in time when the link will expire or has been expired"
        },
        "member_limit": {
          "type": "integer",
          "description": "Maximum number of users that can be chat members"
        },
        "pending_join_request_count": {
          "type": "integer",
          "description": "Number of pending join requests"
        }
      },
      "required": [
        "invite_link",
        "creator",
        "creates_join_request",
        "is_primary",
        "is_revoked"
      ]
    },
    "User": {
      "type": "object",
      "properties": {
        "id": {
          "type": "integer",
          "description": "Unique identifier for this user or bot"
        },
        "is_bot": {
          "type": "boolean",
          "description": "True if this user is a bot"
        },
        "first_name": {
          "type": "string",
          "description": "User's or bot's first name"
        },
        "last_name": {
          "type": "string",
          "description": "User's or bot's last name"
        },
        "username": {
          "type": "string",
          "description": "User's or bot's username"
        },
        "language_code": {
          "type": "string",
          "description": "IETF language tag of the user's language"
        },
        "is_premium": {
          "type": "boolean",
          "description": "True if this user is a Telegram Premium user"
        }
      },
      "required": [
        "id",
        "is_bot",
        "first_name"
      ]
    }
  }
}