Sitecore CDP flow execution data model REST API

Abstract

Provides the attributes for using the Sitecore CDP flow execution data model for REST API (Data model 2.1).

You can send a flow execution request for an interactive experiment using either the browserIdemail, or identifiers attribute. This flexibility is particularly useful when interacting with guests who have never been identified online and do not have a browserId attribute. You can use the email or identifiers attribute to execute a flow that uses a decision model to return the next best offer or action.

You can also send a flow execution request for an interactive experiment when you want to send the output of the decision model in real-time to an external system such as a marketing cloud. The browserId attribute is not relevant or captured by this type of external system, so we recommend using the email or identifiers attribute to execute the flow.

The following table describes flow execution model attributes:

Attribute

Description

Type

Example(s)

clientKey

The client key retrieved from Sitecore CDP.

string

"mhbWwbHYfhpheu86hp60oR76S4jQMmZr"

channel

The channel captured on each page the guest visited.

string (uppercase)

"WEB", "MOBILE_WEB", "MOBILE_APP"

language

The language captured on each page the guest visited.

string (2 letter ISO 639 language code)

"EN", "FR", "DE"

currencyCode

Your organization’s currency code.

3 letter ISO 4217

"EUR", "USD", "NZD"

pointOfSale

The point of sale used.

string (predefined by your organization)

"myretailsite.com", "retailsite.co.uk"

browserId

The ID of a browser generated by Sitecore CDP.

string

"56860bff-94ba-4d84-aa37-2b5a83d5411b"

email

The guest's email address.

string

"john.doe@gmail.com"

identifiers

The unique identifiers of the guest.

JSON object

N/A

The following table describes identifier model attributes:

Attribute

Description

Type

Example(s)

provider

The identifier provider.

string

"ProfileSystem"

id

The identifier identification.

string

"B7524AE6-CF1C-440F-B1A2-0C9D42F5CB41"