Advanced usages
User profiles
A user profile is usually imported from an existing information system, for example CRM, and login database. We usually see our customers using the profile to collect:
- Contact details
- User preferences
- Status in a loyalty program
- Subscription to a newsletter
- CRM information
- Scoring calculated outside the platform
- Aggregated Values
- other details
Each user profile is associated with a user point by a user identifier. It can also be linked to a user account.
User profile object
field
type
description
$user_account_id
String (Optional)
The associated user account ID. If none, the profile remains anonymous.
$compartment_id
Integer (Optional)
The compartment ID. If none, the profile is imported into the default compartment_id.
$last_modified_ts
Timestamp
The timestamp of the last edit operation for this user profile. Automatically set by the system.
$creation_ts
Timestamp
The timestamp of the creation operation for this user profile. Automatically set by the system.
[any custom property]
Any
The value of a custom property
When importing profiles it is recommended to complete the $user_account_id and the $compartment_id event if the values are the same than the ones used as the identifier as the values are not inherited from the identifiers info. You can find more information about the user profiles import.
Example:
1
# User Profile object
2
{
3
"$compartment_id": 1606,
4
"$user_account_id": "c9879698769OIUYOIY9879879",
5
"$last_modified_ts": 5467987654613,
6
"$creation_ts": 6579874654654654,
7
"firstname": "David",
8
"lastname": "Guetta",
9
"gender": 1,
10
"newsletter_options": {
11
"subscribed": true,
12
"preferred_periods": "MONTHLY"
13
}
14
15
}
Copied!
1
# Complete payload when importing a profile
2
{
3
"operation": "UPSERT",
4
"compartment_id": "1600",
5
"user_account_id": "identifier_account_id",
6
"force_replace": true,
7
"user_profile": {
8
"$compartment_id": 1606,
9
"$user_account_id": "c9879698769OIUYOIY9879879",
10
"$last_modified_ts": 5467987654613,
11
"$creation_ts": 6579874654654654,
12
"firstname": "David",
13
"lastname": "Guetta",
14
"gender": 1,
15
"newsletter_options": {
16
"subscribed": true,
17
"preferred_periods": "MONTHLY"
18
}
19
}
20
}
Copied!
You can have different compartment ids and different user accounts between the one in the profile wrapper, as the user point identifier and the one into the user profile object.
Last modified 6mo ago
Copy link