Page Comparison

Update User Profile

Method Objective

The method updates the user's profile or creates a new profile bound to the user's current device if it was not created earlier.

Note
If you don't have user data, never send bogus data. It'll cause problems in profile handling in the future. For example, don't send a non-existent email, like `anonymous@example.com`, or an automatically generated email address that doesn't have anything to do with the user's actual email.

Syntax and parameters

Code Block

language	js
theme	FadeToGrey

personaclick("profile", "set", params, success, error);

Name	Type	Requirement	Description
params	Object	required	Object with request parameters.
success	Function	optionally	A callback function, to which the API response will be passed. Response type: object.
error	Function	optionally	A callback function that will be called when an error occurs (any HTTP status code other than 200).

Main request parameters

Tip

User data must be sent each time it becomes available:

after the user's registration is complete
after the user has logged in to the account
email or phone number (if available) of the authorized user on each page of the site
on the checkout page, if the user is registering (or authorizing) at the time of order placement

Name	Type	Description
email	string	User Email.
first_name	string	User First Name.
gender	string	User Gender (m – male, f – female).
id	number/string	Store side user ID.
last_name	string	User Surname.
phone	string	User Phone.

Additional request parameters

Name	Type	Description
age	number	User age (in years).
auto	Object array	List of vehicles. See description below.
birthday	string	User birthday in the format YYYY-MM-DD.
bought_something	boolean	The user has or hasn't ever bought something in the store.
fb_id	string	Facebook User ID.
kids	Object array	User's children. See description below.
location	string	The user's current location from the list of locations in the product feed.
loyalty_bonuses	number	The current number of store bonuses at the user.
loyalty_bonuses_to_next_level	number	The number of store bonuses necessary for the user to reach the next loyalty level.
loyalty_card_location	string	The location (from the list of locations in the product feed) where the user last used the loyalty card.
loyalty_id	string	The Loyalty Program user ID (loyalty card).
loyalty_status	string	The user's current status in the loyalty program.
telegram_id	string	Telegram User ID.
vk_id	string	VKontakte User ID.

The "auto" object properties

Name	Type	Description
brand	string	Vehicle Brand.
model	string	Vehicle Model.
vds	string	Vehicle's VDS/VIN.

The "kids" object properties

Name	Type	Description
gender	string	Child's age (m – male, f – female).
birthday	string	Child's birthday in the format YYYY-MM-DD.

Custom Properties

Name

Type

Description

A custom property can have any name except the reserved ones

string

The custom property must be created before it can be used. Located there: Account > Settings > Profile Property

Tip
If property creation isn't available in the account, contact PersonaClick support.

integer

float

array of string

jsondate

date (YYYY-MM-DD hh:mm:ss)

Example of use

Code Block

theme	FadeToGrey

personaclick("profile", "set", {
    id: 100500,
    email: "john.doe@examplemail.com", 
    phone: "4400114527199",
    first_name: "John", 
    last_name: "Doe",
    birthday: "1990-03-11", 
    age: 31,
    gender: "m", 
    location: "NY",
    bought_something: true,
    loyalty_id: "000001234567",
    loyalty_card_location: "NY",
    loyalty_status: "5% discount", 
    loyalty_bonuses: 1123,
    loyalty_bonuses_to_next_level: 1877,
    fb_id: "000000000354677",
    vk_id: "vk031845",
    telegram_id: "0125762968357835",
    kids: [
        {gender: "m", birthday: "2001-04-12"},
        {gender: "f", birthday: "2015-07-28"}
    ],
    auto: [
        {brand: "Nissan", model: "Qashqai", vds: "TM7N243E4G0BJG978"}
    ],
    custom_string_property: "the string value of the custom property",
    custom_integer_property: 100500,
    custom_float_property: 7.62,
    custom_array_of_string_property: ["value1", "value2", "value3"],
    custom_json_property: {key1: value1, key2: value2, key3: value3},
    custom_date_property: "2021-12-31 23:55:00"
});

Read User Profile

Method Objective

The method returns accumulated (depersonalized) profile data of the current user.

Note
Most of the data is computational based on the user's interaction with the products.

Syntax and parameters

Code Block

language	js
theme	FadeToGrey

personaclick("profile", "get", callback);

Name	Type	Requirement	Description
callback	Function	required	The callback function that takes the API response. The API response type is an object.

API response

Name

Type

Description

gender

string

The gender of the current user.

Note
If not forced by the "Update User Profile" method, it has the same value as the "computed_gender" property (see below).

computed_gender string The calculated value of gender is based on the user's interaction with the products.

children

Object array

Data about the children of the current user. Each element of the array can contain the following properties:

gender (string) - the child's gender
birthday (string, YYYY-MM-DD format) - the child's birthday
age (number) - the сhild's age

cosmetic_hair

object

The hair properties of the current user:

type (string) - Hair Type. See available values for hair types in the Cosmetics & Perfumes section.
condition (string) - Hair Condition. See available values for hair conditions in the Cosmetics & Perfumes section.

cosmetic_skin

object

The skin properties of the current user:

body (object) - Body Skin Properties
hand (object) - Hands Skin Properties
leg (object) - Legs Skin Properties

Each of the properties above has the following properties and values:

type (string) - Skin Type. See available values for skin types in the Cosmetics & Perfumes section.
condition (string) - Skin Condition. See available values for skin conditions in the Cosmetics & Perfumes section.

cosmetic_perfume

object

Perfume preferences of the current user. The following properties and values are available:

family (array) - Aroma Family. See available values in the Cosmetics & Perfumes section.
aroma (array) - Subgroup of the Aroma Family. See available values in the Cosmetics & Perfumes section.

allergy boolean Whether the current user is allergic.

fashion_sizes

object

Lists clothing types with preferred sizes for each. See available type values in the Apparel & Accessories section.

The value of each property is an array with the user's preferred clothing sizes.

compatibility

object

The preferred brand and model of the vehicle. The following properties are available:

brand (string)
model (string)

vds string The fourth to ninth position in the VIN is the Vehicle Descriptor Section or VDS.

pets

object

The user's pet. The following properties are available:

type (string) - Type of Pet. See available type values in the Pet Products section.
breed (string) - Breed of Pet.
size (string) - Size of Pet. See available size values in the Pet Products section.
age (string) - Age of Pet. See available age values in the Pet Products section.

jewelry

object

The jewelry preferences of the current user. The following properties are available:

metal (String array) - Preferred Metal. See available metal values in the Jewelry section.
color (String array) - Preferred Color. See available color values in the Jewelry section.
gem (String array) - Preferred Gem. See available gem values in the Jewelry section.
gender (String array) - Gender. Available values: "m" or "f".
ring_size (Number array) - Preferred ring sizes of the current user.
bracelet_size (Number array) - Preferred bracelet sizes of the current user.
chain_size (Number array) - Preferred chain sizes of the current user.

realty

object

Real estate of the current user. The following properties are available:

type (string) - Type of Real Estate. See available type values in the Real Estate section.
space (number) - The area of the real estate object.

income_level string The income level of the current user. Available values: cheap, medium, premium.

has_email boolean Does the user's profile contain an email?

custom_properties Object The object contains the values of the custom properties that were marked as available for the public part (frontend). The custom properties are located there: Account > Settings > Profile property

Example of use

Code Block

language	js
theme	FadeToGrey

personaclick("profile", "get", function(profile) {
	console.log(profile.gender);
});

Column

Page Navigation

Table of Contents

maxLevel	2
indent	0px
style	none

Related Pages

Filter by label (Content by label)

showLabels	false
showSpace	false
sort	title
cql	label = "profile"

Versions Compared

Old Version 48

New Version 49

Key

Update User Profile

Method Objective

Syntax and parameters

Main request parameters

Additional request parameters

The "auto" object properties

The "kids" object properties

Custom Properties

Example of use

Read User Profile

Method Objective

Syntax and parameters

API response

Example of use