Sitecore CDP guest data model for REST API

Abstract

Provides the attributes for using the Sitecore CDP standard guest data model for REST API (Data model 2.0).

A guest object is the core entity of Sitecore CDP. The personal data of a customer or prospect is recorded and stored, and all relevant transactional and behavioral data is linked in a guest profile.

The following are guest model attributes:

Attribute

Description

Type

Example(s)

firstSeen

The first seen date for the guest.

ISO 8601 Date/Time UTC

"2015-01-01T16:17:16.000Z"

lastSeen

The last time the guest interacted with your brand. If the guest is currently online and is interacting with your brand, this returns the date and timestamp of when the current session started.

ISO 8601 Date/Time UTC

"2015-01-01T16:17:16.000Z"

guestType

A required Sitecore CDP attribute that represents the level of identity obtained.

string (lowercase)

"visitor, “customer”, "traveler", "retired"

title

The title of the guest.

string (title case)

"Br", "Brigadier", "Capt", "Colonel", "Dame", "Dr", "Elder", "Fr", "General", "Hon", "Judge", "Lord", "Master", "Miss", "Mr", "Mrs", "Ms", "Mstr", "Prof", "Rabbi", "Rev", "Shaikha", "Sheikh", "Sir", "Sister", "Sr"

firstName

The first name of the guest.

string (title case)

"John"

lastName

The last name of the guest.

string (recommend title case)

"Does"

gender

The gender of the guest.

string (lowercase)

"male", "female", "unknown"

dateOfBirth

The date of birth of the guest.

ISO 8601 Date/Time UTC Validation: Date must be in the past.

"1985-12-24T00:00Z"

emails

The email addresses of the guest.

JSON array of strings

["john.does@gmail.com", "john.junior@hotmail.com" ]

phoneNumbers

The phone numbers of the guest.

JSON array of strings

[ "+353161123345", "+353861123311" ]

language

The preferred language of the guest.

string (2 letter ISO 639 language code)

"EN", "FR", "DE"

nationality

The nationality of the guest.

string (title case)

"Irish", "British", "Spanish", "French""Irish", "British", "Spanish", "French"

passportNumber

The passport number of the guest.

string (uppercase)

"PZ4A9565"

passportExpiry

The expiry date of the guest's passport.

string

"2019-01-01T00:00:00.000Z"

street

The street address of the guest.

JSON array of strings (title case)

"Ashford House", "Tara Street", "Dublin 2"

city

The guest's city.

string (title case)

"Dublin", "London", "Madrid", "Paris"

country

The guest's country.

string (2 letter ISO 3166-1 Alpha-2 country code)

"IE", "GB", "ES", "FR"

postcode

The guest's postcode.

string (uppercase)

"D2"

state

The guest's state.

string (title case)

"Oregon"

subscriptions

A list of subscriptions associated with the guest.

JSON array of JSON objects

[ { "name":"default", "channel":"EMAIL", "pointOfSale":"default", "status":"SUBSCRIBED", "effectiveDate":"2012-08-23T16:17:16.000Z" } ]

identifiers

A list of identifiers for the guest.

JSON array of JSON objects

[ { "provider":"BOXEVER_IDENTITY_SYSTEM", "id":"B7524AE6-CF1C-440F-B1A2-0C9D42F5CB41", "expiryDate":"2016-08-23T16:17:16.000Z" } ]

The following are subscription model attributes:

Attribute

Description

Type

Example(s)

Required/optional

name

The subscription name.

string

"default"

Required

channel

The subscription channel.

string

"EMAIL"

Required

pointOfSale

The subscription point of sale (storefront).

string

"myretailsite.com"

Required

status

The subscription status.

string

"UNKNOWN", "PENDING", "SUBSCRIBED", "UNSUBSCRIBED"

Required

effectiveDate

The effective date of the subscription.

ISO 8601 Date/Time UTC

"2015-01-01T16:17:16.000Z"

Required

The following are identifier model attributes:

Attribute

Description

Type

Example(s)

Required/optional

provider

The identifier provider.

string

"ProfileSystem"

Required

id

The identifier ID.

string

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

Required

expiryDate

The expiry date of the identifier.

ISO 8601 Date/Time UTC

"2015-01-01T16:17:16.000Z"

Optional

The following are the standard response attributes:

Attribute

Description

Type

Example(s)

href

The resource fully qualified location Uniform Resource Identifier (URI).

string

"https://{apiEndpoint}/v2/{resourceName}/{resourceRef}"

ref

The reference of the resource.

string UUID

"9d94ee11-7043-4b71-980c-a777d00a7b46"

createdAt

Date and time when the resource was created in Sitecore CDP.

ISO 8601 Date/Time UTC

"2015-01-01T16:17:16.000Z"

modifiedAt

Date and time when the resource was updated in Sitecore CDP.

ISO 8601 Date/Time UTC

"2015-01-01T16:17:16.000Z"