Documentation

    Multi-Language Support

    Co-Browsing API supports custom translations for all user-facing text. You can configure them per language through the dashboard, or set them during initialization.

    Basic Translation Setup

    Pass translation strings directly to the init function:

    Upscope("init", {
      authorizationPromptTitle: "Co-Browsing request",
      authorizationPromptMessage: "Would you like to let {%agentName%|our agent} co-browse with you?",
      translationsYes: "Yes",
      translationsNo: "No",
    });
    

    Multi-Language Setup

    Instead of a string, every text option also accepts an object keyed by language code. Co-Browsing API automatically shows the translation matching the visitor's browser language, falling back to en if their language isn't included:

    Upscope("init", {
      authorizationPromptTitle: {
        en: "Co-Browsing request",
        fr: "Demande de co-navigation",
        es: "Solicitud de co-navegación",
      },
      authorizationPromptMessage: {
        en: "Would you like to let {%agentName%|our agent} co-browse with you?",
        fr: "Souhaitez-vous permettre à {%agentName%|notre agent} de co-naviguer avec vous ?",
        es: "¿Le gustaría permitir que {%agentName%|nuestro agente} co-navegue con usted?",
      },
      translationsYes: { en: "Yes", fr: "Oui", es: "Sí" },
      translationsNo: { en: "No", fr: "Non", es: "No" },
    });
    

    You can also configure all of these translations per language through the dashboard, without any code changes.

    Available Translation Keys

    See the Messages section of Configuration Options for a complete list of translatable strings.