---
title: "Call the Personalize API"
slug: "call-the-personalize-api"
abstract: "Describes how to run an interactive experiment or experience using the Personalize REST API (Sitecore Personalize)."
---
# Call the Personalize API

`POST /v2/callFlows`

Runs an interactive experiment or experience over any web-based or mobile application.

When you send a flow execution request, you can only use one of these attributes; `browserId`, `email`, or `identifiers`.

> [!important]
> To have any converted goals included in the attribution rate, you must use the `browserId` attribute to execute a flow. This stores the experiment or experience in the same session every time it runs. This ensures that any goals the marketer added to the interactive experiment or experience are attributed to the correct browser session, the conversion is counted, and the attribution rate is accurate when the marketer [views performance analytics](https://doc.sitecore.com/personalize/en/users/sitecore-personalize/en/view-performance-analytics-in-sitecore-personalize.html).

To store the experiment or experience in a separate session every time it runs, use the `email` or the `identifiers` attribute.

Optionally, you can include custom fields using the `params` object.

Run an experiment or experience using `browserId`:

```curl
curl -X POST '<baseURL>/v2/callFlows' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '
{
    "clientKey": "abBah8aelipaPeebae7roox2tiexoSee",
    "channel": "WEB",
    "language": "en",
    "currencyCode": "EUR",
    "pointOfSale": "myretailsite/ireland",
    "browserId": "a38b230c-11eb-4cf9-8d5d-274e9f344925​",
    "friendlyId": "home_page_banner"
}'

```

Run an experiment or experience using `email`:

```curl
curl -X POST '<baseURL>/v2/callFlows' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '
{
    "clientKey": "abBah8aelipaPeebae7roox2tiexoSee",
    "channel": "WEB",
    "language": "en",
    "currencyCode": "EUR",
    "pointOfSale": "myretailsite/ireland",
    "email": "jane.doe@myretailsite.com",
    "friendlyId": "home_page_banner"
}'

```

Run an experiment or experience using `identifiers`:

```curl
curl -X POST '<baseURL>/v2/callFlows' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '
{
    "clientKey": "abBah8aelipaPeebae7roox2tiexoSee",
    "channel": "WEB",
    "language": "en",
    "currencyCode": "EUR",
    "pointOfSale": "myretailsite/ireland",
    "identifiers":{
      "id":"123456",
      "provider":"BXLP"
    },
    "friendlyId": "home_page_banner"
}'

```

Include custom fields:

```curl
curl -X POST '<baseURL>/v2/callFlows' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '
{
    "clientKey": "abBah8aelipaPeebae7roox2tiexoSee",
    "channel": "WEB",
    "language": "en",
    "currencyCode": "EUR",
    "pointOfSale": "retailsite.com",
    "browserId": "a38b230c-11eb-4cf9-8d5d-274e9f344925​",
    "params":{
      "loggedInState":"loggedIn",
      "someKey":"someValue"
    },
    "friendlyId": "home_page_banner"
}'

```

Include UTM parameters in the `params.utm` object:

```curl
curl -X POST '<baseURL>/v2/callFlows' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '
{
   "clientKey":"abBah8aelipaPeebae7roox2tiexoSee",
   "channel":"WEB",
   "language":"en",
   "currencyCode":"EUR",
   "pointOfSale":"retailsite.com",
   "browserId": "a38b230c-11eb-4cf9-8d5d-274e9f344925​",
   "params":{
      "utm":{
         "campaign":"summer_sale",
         "source":"newsletter",
         "medium":"email",
         "content":"running shoes"
      }
   },
   "friendlyId":"home_page_banner"
}

```

```json

    {
    "trackingUrl": "<apiEndpoint>/v3/trackers/eyJjaGFubmVsIj",
      "Name": "Ancillary bundle",
      "imageURLForTesting": "https://png.icons8.com/ios/50/000000/cardboard-box.png"
    },
    {
    "trackingUrl": "<apiEndpoint>/v3/trackers/eyJjaGFubmVsIj",
      "Name": "Ancillary seat",
      "imageURLForTesting": "https://png.icons8.com/dotty/50/000000/flight-seat.png"
    },
    {
    "trackingUrl": "<apiEndpoint>/v3/trackers/eyJjaGFubmVsIj",
      "Name": "Ancillary bag",
      "imageURLForTesting": "https://png.icons8.com/metro/50/000000/suitcase.png",
      "nonDependent": "false"
    },
    {
    "trackingUrl": "<apiEndpoint>/v3/trackers/eyJjaGFubmVsIj",
      "Name": "Ancillary insurance",
      "imageURLForTesting": "https://png.icons8.com/ios/50/000000/umbrella.png",
      "nonDependent": "false"
    }
]

```