For the complete documentation index, see llms.txt. This page is also available as Markdown.

UserProfile

The timeless information you hold about a user, how it attaches to a UserPoint, and what to fill when you import it.

Your goal

Know what a UserProfile holds and how it attaches to a user, so that the profiles you import land on the right UserPoint, in the right compartment.

Expected outcome

Profiles that carry the account and compartment they belong to, and that hold the timeless information your use cases need.

What a UserProfile is

A UserProfile is a summary of timeless information about the user, such as first name, last name, birth date, address, or age. It is usually imported from an existing information system such as a CRM or a login database, and typically collects:

  • Contact details.

  • User preferences.

  • Status in a loyalty programme.

  • Subscriptions to a newsletter.

  • CRM information.

  • Scores calculated outside the platform.

  • Aggregated values.

Each UserProfile is associated with a UserPoint by a user identifier. It can also be linked to a UserAccount.

A UserPoint can carry several UserProfiles on the same datamart, kept apart by compartment - for example a profile on one of your sites and another profile on another site.

The profile object

Field
Type
Description

$user_account_id

String, optional

The associated UserAccount ID. If none, the profile remains anonymous.

$compartment_id

Integer, optional

The compartment ID. If none, the profile is imported into the default compartment.

$last_modified_ts

Timestamp

The timestamp of the last edit operation on this profile. Set automatically by the system.

$creation_ts

Timestamp

The timestamp of the creation of this profile. Set automatically by the system.

any custom property

Any

The value of a custom property.

When importing profiles

A UserProfile carries $user_account_id and $compartment_id of its own, separately from the identifier used to route the import.

The compartment ID and the account in the profile object can legitimately differ from the ones used as the UserPoint identifier. See Import profiles.

Verify

  • Every imported profile carries $user_account_id and $compartment_id inside the profile object.

  • A known test user shows the profile in the compartment you targeted.

Last updated

Was this helpful?