Skip to main content

Sitecore CDP guest extensions data model for REST API

Abstract

Provides attribute definitions and JSON examples for using Sitecore CDP guest extension data model for REST API (Data model 2.1).

This topic provides attribute definitions and a JSON example for using Sitecore CDP guest extension data model. You must follow guest extension guidelines when using guest data extensions.

The following are guest extensions model attributes:

Attribute

Description

Type

Example(s)

extensions

A list of data extensions associated with the guest. Only one data extension is supported. You can request this feature from your Sitecore representative.

JSON array of JSON objects

N/A

extensions.name

Set this to "ext"

string

"ext"

extensions.key

Set this to "default"

string

"default"

extensions.attribute

One or many name/value pair attributes for custom data. The name must follow attribute naming guidelines.

Supported types for the "value": string: "Hello", boolean: true or false, integer: 9, number: 99.9

"status": "PLACED"

The following is a JSON example that uses guest extension data model attributes:

{
   "href":"https://{apiEndpoint}/v2/guests/9d94ee11-7043-4b71-980c-a777d00a7b46/extExt/0349654D-5DB7-4103-8C9E-88953648EE18",
   "ref":"0349654D-5DB7-4103-8C9E-88953648EE18",
   "createdAt":"2010-03-07T16:15:11.000Z",
   "modifiedAt":"2012-08-23T16:17:16.000Z",
   "extensions":[
      {
         "name":"ext",
         "key":"default",
         "loyaltyTier":"level2",
         "rewardBalance":5012.25,
         "vipMember":true,
         "loyaltyNumber":123456789
      }
   ]
}