Developer/IT > Whisbi API > API Reference > General Config > Introduction

Introduction

These are all the general settings that are shared between Engage, Guide, and Sell. This means that all this customisation settings will be applied to both of them.

Name	Description	Required
`language` String	The ISO 639-1 code of the language to display the widget in (lower case)	Optional Default: en
`languageVariation` String	Code to indicate a variation of the language defined (lower case). Codes: – ’fm’ for formal tone	Optional
`privacyPolicyURL` String	The URL that redirects to your company’s legal terms	Optional
`textsURL` String	A URL where a valid translation JSON file is stored. It can contain all the texts of the widget or just the ones you need to change. Keep in mind that the texts customized directly on the API have priority over those in the JSON file. Request the JSON file with the default texts to your designated Customer Success Manager.	Optional
`googleAnalytics` Boolean	If set to false, Whisbi’s Google Analytics tracking code is disabled	Optional Default: true
`googleAnalyticsClientId` String	The Google Analytics id to which send tracking events (this id has the form: UA-XXXXX-Y). Only add this parameter if you intend to receive analytics events to a specific Google Analytics account.	Optional
`enableWhisbiLink` Boolean	If set to false, the link placed at the bottom of the Widget will be disabled	Optional Default: true
`whisbi.GeneralTextsConfig` texts	Shared texts between the Engage, Guide and Sell widget	Optional
`whisbi.GeneralStylesConfig` styles	Shared styles between the Engage, Guide and Sell widget	Optional
`general.styles.bubble.textColor` styles	Set the color of the texts in the floating button	Optional Default: #444444
`general.styles.floatingButton.closeIconColor` styles	Set the color of the close icon in the floating button	Optional Default: #666
`general.styles.header.iconColor` styles	Set the color of the elements (close, back icons) in the navigation	Optional Default: #444444
`general.styles.placeholderColor` styles	Set the color of the placeholder texts in the input fields	Optional Default: #444444
`general.styles.footer.textColor` styles	Set the color of the footer (Powered by Whisbi)	Optional Default: #00010040
`general.styles.oneToOne.styles.inputs.borderColor` styles	Set the color of the border of the input fields unfocused	Optional Default: #bbbdc0
`general.styles.oneToOne.styles.inputs.inputIconColor` styles	Set the color of the icons in the input fields	Optional Default: #bbbdc0
`general.styles.oneToOne.styles.checkbox.borderColor` styles	Set the color of the border of the checkbox for privacy policy consent	Optional Default: #bbbdc0
`general.styles.oneToOne.styles.inputs.errorBorderColor` styles	Set the color of the border of the input field when an error is displayed	Optional Default: #de2929

EXAMPLE

var conf = {

  version: '1.32.0',

  api: {...},

  general: {

    language: 'en',

    languageVariation: 'fm',

    textsURL: '',

    texts: {

      companyName: '',

      privacyPolicy: ''

    },

    enableWhisbiLink: true,

	   privacyPolicyURL: '',

    styles: {

      theme: '',

      fonts: [],

      fontFamily: '',

      textColor: '',

      linkColor: '',

      primaryColor: '',

      secondaryColor: '',

      placeholderColor: '',

      header: {

        fontFamily: '',

        fontSize: '',

        fontWeight: '',

        backgroundColor: '',

        textTransform: '',

        textColor: '',

        iconColor: ''

      },

      footer: {

	 textColor: ''

	},

      bubble: {

	textColor: ''

       },

      floatingButton: {

      closeIconColor: ''

      },

      titles: {...}

    }

  },

  oneToMany: {...},

  oneToOne: {

    styles: {

       checkbox:{

       borderColor:",

       },

	inputs: {

	borderColor: ",

	errorBorderColor: ",

	inputIconColor: "

	},

     },

  },

  events: {...}

};

whisbi.setup(conf);

Copy Code