Branding

Branding lets you apply one of your organisation’s journey themes to an individual hosted journey. The theme controls the colours, corners, logo, and text styles on the screens your customers see. You select a theme in the Journey builder, on the Branding panel. The themes available to you are the ones created in Settings. To create or edit a theme, see Create journey themes. If you run journeys on behalf of more than one brand, or your organisation is part of a partner organisation, then you can also brand journeys for a sub-organisation or apply a theme through the API for a single journey run.

Branding applies to hosted journeys only, in both Low-code and No-code delivery. An API-first integration renders its own screens, so it doesn’t use a journey theme.

Before you begin

Ensure you have the following:

A hosted journey with its modules configured in the Journey builder.
At least one journey theme created in Settings. If your organisation hasn’t created a theme, then the journey uses the Default theme.

Apply a theme to a journey

You apply the theme after you configure your journey. To apply a theme:

Open your hosted journey in the Journey builder.
Click Branding.
Select a theme from the Journey theme list.
Click Publish to Preview.

Your journey now uses the theme you selected. The Branding panel links to Account settings, where you manage the themes themselves.

Apply the same theme to every journey in a customer-facing flow. Customers who see a consistent logo and colour scheme across screens are less likely to abandon a journey because they doubt it’s genuine.

Preview the branded journey

Publishing to Preview applies the theme and makes your branded screens available to test. Launch the journey in the preview environment to see them. Check that your logo, colours, and text styles render as you expect before you publish to production. To publish the journey to production, see Publish journey.

Apply a theme through the API

You can select a theme at the point you start a hosted journey, instead of applying it to the journey in the Journey builder. This is useful when one journey serves several brands, because you choose the branding for each journey instance rather than for each published journey. The theme applies to that journey run only. It takes precedence over the theme applied in the Journey builder, and over your organisation’s default theme.

Find the theme resource ID

You identify the theme by its resource ID, shown above the Branding and Text styles tabs in Settings. To find the resource ID of a theme:

In GBG Go, click Settings.
Click the Journey Themes tab.
Select your theme from the theme list.
Copy the resource ID and version shown above the Branding and Text styles tabs.

Start the journey with a theme

Send a POST request to the /journey/start endpoint with the resource ID of the published hosted journey. Include "delivery": "page" in the config object to indicate that this is a hosted journey, and branding.resource to select the theme. Sample request:

cURL

curl --request POST \
  --url https://eu.platform.go.gbgplc.com/v2/captain/journey/start \
  --header 'Authorization: Bearer your-access-token' \
  --header 'Content-Type: application/json' \
  --data '{
    "resourceId": "your-journey-delivery-resource-id@version",
    "context": {
      "config": {
        "delivery": "page",
        "branding": {
          "resource": "your-theme-resource-id@version"
        }
      },
      "subject": {}
    }
  }'

Request body fields:

Field	Required	Description
`resourceId`	Yes	The unique identifier for the published journey, in the format `{hash}@{version}`.
`context.config.delivery`	Yes	The delivery mode. Set to `"page"` for hosted journeys.
`context.config.branding.resource`	No	The resource ID of the journey theme to apply. If you omit it, then the journey uses the theme applied in the Journey builder, or the Default theme.
`context.subject`	Yes	An empty object `{}` for non-prefill mode, or structured identity data for partial prefill mode.

branding.resource applies to hosted journeys only. An API-first integration renders its own screens, so a theme sent with "delivery": "api" has no effect.

Your organisation needs permission to set the brand for a journey run. If the platform doesn’t apply your theme, then contact your GBG account manager to check that your organisation is set up for it.

Choose a theme version

The resource ID ends with the theme version, such as @v3. You can name a version in two ways:

Value	Description
A version number, such as `@v3`	The journey always uses that version of the theme, even after someone edits it. Recommended, because you control exactly what your customers see.
`@latest`	The journey uses the most recently published version of the theme. Useful when you want theme edits to reach live journeys without changing your integration.

Using @latest takes slightly longer to start a journey, because the platform looks up the current version each time. There’s also a short delay before a theme edit reaches journeys that use @latest. Name a version number when either matters to you.

Change the theme on a journey

To change the theme:

Open your hosted journey in the Journey builder.
Click Branding.
Select a different theme from the Journey theme list.
Click Publish to Preview.

The journey uses the new theme from the next version you publish. Journeys your customers have already started continue to use the theme that was applied when they started.

Editing a theme in Settings changes every journey that uses it, including journeys already published to production. Apply a separate theme to a journey when you want to change its branding on its own.

How GBG Go chooses a brand

A journey can get its branding from more than one place. The GBG Go platform uses the first of the following that applies:

A brand set for one journey run: Your integration names a theme when it starts the journey. This applies to that run only.
Your organisation’s default theme: If you belong to a sub-organisation, the platform uses your own organisation’s default theme, not the parent organisation’s.
The Default theme: Every organisation has one, so a journey always has branding to fall back on.

A journey keeps the branding it starts with. Editing the theme, or changing which theme the journey uses, doesn’t affect journeys that are already running.

Branding for sub-organisations

If your organisation is part of a partner organisation, then you run journeys that the parent organisation builds and shares with you. Your customers still see your own branding. When you send an invite from the GBG Go platform, or launch a journey from the Dashboard, the platform applies your organisation’s own default theme to the screens your customers see. You don’t need to configure anything, and the parent organisation doesn’t need to create a theme for you. To change what your customers see, edit your organisation’s default theme, or create a theme of your own and set it as the default. See Create journey themes.

Next steps

Create journey themes

Create and edit the themes available to your journeys.

Get Started

Platform

API-first integration

Hosted journey

Digital IDs

Resources

Before you begin

Apply a theme to a journey

Preview the branded journey

Apply a theme through the API

Find the theme resource ID

Start the journey with a theme

Choose a theme version

Change the theme on a journey

How GBG Go chooses a brand

Branding for sub-organisations

Next steps

Create journey themes

​Before you begin

​Apply a theme to a journey

​Preview the branded journey

​Apply a theme through the API

​Find the theme resource ID

​Start the journey with a theme

​Choose a theme version

​Change the theme on a journey

​How GBG Go chooses a brand

​Branding for sub-organisations

​Next steps

Create journey themes

Before you begin

Apply a theme to a journey

Preview the branded journey

Apply a theme through the API

Find the theme resource ID

Start the journey with a theme

Choose a theme version

Change the theme on a journey

How GBG Go chooses a brand

Branding for sub-organisations

Next steps