Bot

A bot, as writing one and as reading one both report it. It carries everything a listing item does, plus the two things only a single bot's answer knows — the channels it is reached through and whether its draft carries changes — and minus who wrote each side, which a caller looking at one bot has not asked for.

  • builder_version
    Type: string
    required

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

  • channel_family
    Type: ChannelFamilyenum
    required
    values
    landbotwhatsappfacebookapichat
  • channels
    Type: array of stringFormat: uuid
    required

    The channels that serve the bot. A web bot is created with one; a bot can be served by more than one, and channels are managed outside this API.

  • 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.

  • has_unpublished_changes
    Type: boolean
    required

    Whether the draft differs from what is published. A bot that has never been published always has changes to publish.

  • id
    Type: stringFormat: uuid
    required
  • is_active
    Type: boolean
    required

    Whether the bot serves conversations. This is separate from state: a bot in the active state can still be deactivated, and a trashed bot never serves regardless of this flag.

  • is_published
    Type: boolean
    required

    Whether a published version exists

  • name
    Type: string
    max length:  
    50
    required
  • preview_only
    Type: boolean
    read-only
    required

    The bot runs in preview only, because it needs a higher plan tier than the brand has, or because the brand's subscription has lapsed. Derived on the subscription side and never set through this API.

  • required_tier
    Type: PlanTierenum
    required

    The lowest plan tier that can run this bot, worked out from the blocks in its draft.

    values
    sandboxstarterprofessionalbusiness
  • edited_at
    Type: Timestamp

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

  • last_published_at
    Type: Timestamp

    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.

  • state
    Type: BotStateenum

    Whether the bot is in use or in the trash. Reported by reading a bot and by writing one alike: the trash is a state of the bot, so a write knows which side of it the bot it left behind is on.

    values
    activetrashed
  • workspace
    Type: integer

    The workspace the bot belongs to. Absent when it belongs to none. Workspaces are not managed through this API and are identified by an integer, as they have no uuid.