Configure your code-based experience

Last update: June 2, 2025

CREATED FOR:

  • Experienced
  • Admin

Before building your experience, you need to create a code-based experience configuration in which you define where the content will be delivered and consumed inside your application.

A code-based experience configuration must reference the surface, which is basically the location where you want to render your changes. According to the selected platform, you need to enter a location/path, or the full surface URI. Learn more

NOTE
When you have multiple code-based experience actions using the same channel configuration (and thus running on the same surface), the campaign or journey’s Priority score determines what is delivered to the end-user if they qualify for more than one action. Learn more on priority scores

Create a code-based experience configuration

To create a code-based experience channel configuration, follow these steps:

  1. Access the Channels > General settings > Channel configurations menu, then click Create channel configuration.

  2. Enter a name and a description (optional) for the configuration.

    NOTE
    Names must begin with a letter (A-Z). It can only contain alpha-numeric characters. You can also use underscore _, dot. and hyphen - characters.

  3. To assign custom or core data usage labels to the configuration, you can select Manage access. Learn more about Object Level Access Control (OLAC)

  4. Select Marketing action(s) to associate consent policies to the messages using this configuration. All consent policies associated with the marketing action are leveraged in order to respect the preferences of your customers. Learn more

  5. Select the Code-based experience channel.

  6. Select the platform for which the code-base experience will be applied:

    NOTE
    You can select several platforms. When choosing multiple platforms, the content is delivered to all the selected pages or apps.

  7. Choose the format expected by the application for this particular location. This will be used when authoring the code-based experience in campaigns and journeys.

  8. Click Submit to save your changes.

You can now select this configuration when creating a code-based experience in your campaigns and journeys.

NOTE
Your app implementation team is responsible for making explicit API or SDK calls to fetch content for the surfaces defined in the selected code-based experience configuration. Learn more about the different customer implementations in this section.

Web platforms

To define the code-based experience configuration settings for web platforms, follow the steps below.

  1. Select one of the following options:

    • Single page - If you want to apply the changes to a single page exclusively, enter a Page URL.

    • Pages matching rule - To target multiple URLs matching the same rule, build one or more rules. Learn more

      For example, if you want to edit elements that are displayed on all the women product pages of your Luma website, select Domain > Starts with > luma and Page > Contains > women.

  2. The following applies for the preview URL:

    • If a single page URL is entered, that URL will be used for the preview - no need to enter another URL.

    • If a pages matching rule is selected, you must enter a Default authoring and preview URL that will be used to preview the experience in a browser. Learn more

  3. The Location on page field specifies the exact destination inside the page you want users to access. It can be a particular section on a page within the site’s navigation structure, such as ‘hero-banner’ or ‘product-rail’.

    CAUTION
    The string or path entered in this field must match the one declared in your app or page implementation. This ensures that the content is delivered to the desired location inside the specified app or page. Learn more