Create a browser reference in Sitecore CDP

Abstract

Describes how to create a browser reference in Sitecore CDP (Data model 2.1).

Use the Browser Service to create a browser reference (ref) and customer reference (customer_ref) with the guestType attribute set to Visitor. The customer_ref is the unique guest reference.

Both references are included in the response. This functionality is supported by the Boxever JavaScript Library version 1.4.7.

To create a browser reference in Sitecore CDP, use the following:

GET https://{apiEndpoint}/v1.2/browser/create.json?client_key={{CLIENT_KEY}}&message={}

Parameter

Type

Description

client_key

string

Your organization's unique identifier.

message

string

The body of the message. Leave this empty for retrieving the browserId attribute.

The following 200 (OK) status code indicates that the request was successfully processed:

{
   "status":"OK",
   "version":"1.2",
   "client_key":"ghsPMFpfrXBzxKozB0IoL4yyAT0s7WrH",
   "ref":"4888p5d9-6117-4f8d-a182-271c3e917103",
   "customer_ref":"96399992-e333-444e-bta0-74dd8486f018"
}