ChannelDesign

The whole channel. The fields listed are a web bot's; a channel of another kind carries its own instead. It answers more keys than are listed here.

  • id
    Type: integer
    required

    Integer numbers.

  • name
    Type: string
    required
  • type
    Type: string
    required
  • uuid
    Type: stringFormat: uuid
    required
  • brand_name
    Type: string
  • conditional_proactives
    Type: object
    Properties: 1
  • config_url
    Type: string

    Where the channel's configuration is served to a visitor.

  • design
    Type: object

    The colours, fonts and layout the widget is drawn with.

    Properties: 1
  • favicon
    Type: string
  • foot
    Type: string

    Markup placed at the end of the page's body.

  • head
    Type: string

    Markup placed in the page's head.

  • hidden_fields
    Type: object
    Properties: 1
  • launcher_config
    Type: object
    Properties: 1
  • logo
    Type: string
  • merged
    Type: boolean

    Whether the live channel and the one a test conversation runs on hold the same thing. false after a write that asked for autosave.

  • persistent_menu
    Type: array of object
    Properties: 1
  • status
    Type: string
  • style
    Type: string

    CSS, applied on top of the design.

  • tagline
    Type: string
  • text
    Type: object
    Properties: 1
  • token
    Type: string

    What a visitor's page identifies the channel by.

  • typing_options
    Type: object
    Properties: 1
  • url
    Type: string
    read-only

    Where a visitor opens the bot. Worked out for you; writing it does nothing.

  • version
    Type: string

    Which widget the channel is drawn by.

  • welcome
    Type: array of object

    What the page shows before the conversation is opened.

    Properties: 1
  • propertyName
    additionalPropertyType: anything