Skip to contentSkip to navigationSkip to topbar
Rate this page:
On this page

Enable Flex UI 2.x.x on your account


This page explains how to enable Flex UI 2.x.x on your Flex application. For more information about the entire migration process, see Migrate from Flex UI 1.x.x to 2.x.x.


Enable Flex UI 2.x.x on your account

enable-flex-ui-2xx-on-your-account page anchor

Using the Versioning and Updates page on flex.twilio.com

using-the-versioning-and-updates-page-on-flextwiliocom page anchor

Flex UI 2.x.x is now in General Availability. You can install it by accessing the Versioning and updates(link takes you to an external page) page of your Flex app Admin Dashboard. If you are running a 1.x.x version, select 2.x.x and click Confirm. If you are on a Public Beta version of 2.x.x, install 2.x.x by clicking on the 2.x.x version link and then Install. Your application will now be upgraded to Flex UI 2.x.x.

Using the Configuration service API

using-the-configuration-service-api page anchor

To change the ui_version and reset your ui_dependencies, you can make the following curl request. Change the version number in this curl request (2.x.x) to the current version number that you're migrating to. You can retrieve your account SID and auth token from the Twilio Console(link takes you to an external page).


_11
curl --request POST \
_11
--url https://flex-api.twilio.com/v1/Configuration \
_11
-u ACXXXXXXXXXXXXXXXXXXXXX:auth_token \
_11
--header 'accountsid: ACXXXXXXXXXXXXXXXXXXXXX' \
_11
--header 'content-type: application/json' \
_11
--header 'i-twilio-auth-account: ACXXXXXXXXXXXXXXXXXXXXX' \
_11
--data '{
_11
"account_sid": "ACXXXXXXXXXXXXXXXXXXXXX",
_11
"ui_version": "~2.x.x",
_11
"ui_dependencies": {}
_11
}'

You can install Flex UI 2.x.x via yarn or npm:

yarnnpm

_10
yarn add @twilio/flex-ui@^2

Refer to Upgraded dependencies if you run into compatibility issues which you will need to resolve.

Using the flex-ui-sample package

using-the-flex-ui-sample-package page anchor

If you want to use or are using the flex-ui-sample package for bootstrapping your project, make sure to pull the latest from the main branch of the flex-ui sample repo(link takes you to an external page) which requires the @twilio/flex-ui@^2 package. We have also bumped React to version 17 to satisfy the Flex 2.x requirements. This means that on any existing project, you have to resolve compatibility issues in your code should they occur.


Rate this page: