> ## Documentation Index
> Fetch the complete documentation index at: https://docs.pureclarity.com/llms.txt
> Use this file to discover all available pages before exploring further.

# User Feed Model

> The User Data Feed can hold detailed information about a user that PureClarity can use to define customer segments. There are a few standard fields such as UserId and FirstName but you can provide any number of Custom Fields as part of the feed, e.g. Marketing Preferences or any personal information known.  You are able to create customer segments for each custom field sent in the user feed.
<Note>PureClarity will either update the information for an existing user or will add a new user if PureClarity has no information for that user.</Note>
<Note>Please note that there are certain types of information that are you are not allowed to send to us under our Terms and Conditions. These are classes of data that under GDPR would be classed as Special Category Data.</Note>
Restricted data includes: * Race
* Ethnic origin
* Politics
* Religion
* Trade union membership
* Genetics
* Biometrics (where used for ID purposes)
* Health
* Sex life or Sexual orientation
* Offences
Custom fields can also be sent. These can be of type String, Number, Boolean or Array of strings. For example “VIPCustomer”: true.

The User Data Feed can hold detailed information about a user that PureClarity can use to define customer segments. There are a few standard fields such as UserId and FirstName but you can provide any number of Custom Fields as part of the feed, e.g. Marketing Preferences or any personal information known.  You are able to create customer segments for each custom field sent in the user feed.

<Note>PureClarity will either update the information for an existing user or will add a new user if PureClarity has no information for that user.</Note>

<Note>Please note that there are certain types of information that are you are not allowed to send to us under our Terms and Conditions. These are classes of data that under GDPR would be classed as Special Category Data.</Note>

Restricted data includes:

* Race

* Ethnic origin

* Politics

* Religion

* Trade union membership

* Genetics

* Biometrics (where used for ID purposes)

* Health

* Sex life or Sexual orientation

* Offences

Custom fields can also be sent. These can be of type String, Number, Boolean or Array of strings. For example “VIPCustomer”: true.

## Properties

<ParamField body="UserId" type="string" required>
  Unique User Id. This should be the same identifier sent to PureClarity in the tracking events (customer\_details and order\_track).
</ParamField>

<ParamField body="GroupId" type="string">
  Optional user group. Used to support price banding (prices per user group)
</ParamField>

<ParamField body="Email" type="string">
  Customer’s email address
</ParamField>

<ParamField body="FirstName" type="string">
  Customer’s first name
</ParamField>

<ParamField body="lastName" type="string">
  Customer’s last name
</ParamField>

<ParamField body="Title" type="string">
  Mr, Mrs, Miss, Ms, Dr, etc.
</ParamField>

<ParamField body="DOB" type="string">
  Date of Birth. NOTE: PureClarity derives ‘Age’ from DOB for Behavioral Profiling. Format is DD/MM/YYYY
</ParamField>

<ParamField body="Gender" type="string">
  Male or Female
</ParamField>

<ParamField body="City" type="string">
  Location of City or Town
</ParamField>

<ParamField body="State" type="string">
  Users location state
</ParamField>

<ParamField body="Country" type="string">
  Users country
</ParamField>