BotSummary

A bot as a listing reports it. It is read from the bot's own rows and from nothing else, so it carries no avatar, no channel and no conversation counters — those belong to other contexts and are not served here yet.

  • builder_version
    Type: string
    required

    Which builder built the bot. Only the current one can be written; every version is listed.

  • channel_family
    Type: ChannelFamilyenum
    required
    values
    landbotwhatsappfacebookapichat
  • created_at
    Type: Timestamp
    required

    A moment, in UTC, written as YYYY-MM-DDTHH:MM:SS. It carries no offset and no fraction of a second, so a client that reads it as local time is wrong by whatever its own offset is.

  • id
    Type: stringFormat: uuid
    required
  • is_active
    Type: boolean
    required
  • is_published
    Type: boolean
    required
  • name
    Type: string
    required
  • preview_only
    Type: boolean
    read-only
    required
  • required_tier
    Type: PlanTierenum
    required

    A subscription tier, ordered from lowest to highest.

    values
    sandboxstarterprofessionalbusiness
  • state
    Type: BotStateenum
    required

    active is a bot in use. trashed is a bot that has been deleted but is recoverable; it does not serve conversations.

    values
    activetrashed
  • edited_at
    Type: Timestamp

    When the content last changed. Absent on a bot that has never been written to.

  • edited_by
    Type: Author

    Who last changed the content, read from the same side as edited_at.

    Properties: 2
  • last_published_at
    Type: Timestamp

    When the bot was last published. Absent until it has been published, and it is what the default order sorts by.

  • published_by
    Type: Author

    Who published it last. Absent until the bot has been published.

    Properties: 2
  • workspace
    Type: integer

    Integer numbers.