BlockVariant

  • channel_restriction
    Type: array of ChannelFamilyenum
    required

    Channel families this variant is valid on. Empty means every one of them.

  • interaction
    Type: InteractionKindenum
    required

    Whether the block pauses the conversation waiting for the user. This is what makes a cycle in the diagram legitimate or not: a loop through blocks that never wait is an error.

    values
    waits_for_inputruns_without_input
  • output_derivations
    Type: array of OutputDerivation
    required

    Rules the caller runs over its own params to know the outputs this variant reports for them, on top of the fixed outputs — a button block reports one output per button. Empty when every output is fixed.

    Properties: 4
  • outputs
    Type: array of BlockOutput
    required

    The fixed outputs a connection can leave from, as used in a connection's type.

    Properties: 2
  • param_derivations
    Type: array of ParamDerivation
    required

    Params this variant works out itself rather than the caller writing them, and the param each one is worked out from. What a caller sends for a derived param is replaced or kept according to the derivation's kind. Empty when every param is the caller's. Applied when a block is added or edited, and not by PUT /bots/{bot_id}/draft, which stores what it is given.

    Properties: 3
  • params
    Type: array of ParamDefinition
    required
    Properties: 12
  • required_tier
    Type: PlanTierenum
    required

    A subscription tier, ordered from lowest to highest.

    values
    sandboxstarterprofessionalbusiness
  • selector
    Type: array of ParamSelector
    required

    The conditions over a block's own params that select this variant. Empty on a single-variant block, which any params select.

    Properties: 5
  • answer
    Type: string | nullenum

    What kind of answer the block collects, for the blocks that ask for one. Absent on a block that asks for nothing.

    values
    emailphoneurlnumberdate