Customer Identity object

{
  "id": 863291377,
  "first_name": "Jane",
  "last_name": "Doe",
  "email": "jane@doe.com",
  "distinct_id": "cust_19238475",
  "properties": {},
  "customer_id": 123
}

Customer identities represent individuals or entities in an external system and how they map to customers in a Smile loyalty program. They contain basic details like email and name, along with the external system’s unique identifier for the individual. In practice, a single customer in Smile may have zero, one, or many different customer identities.

integer

Unique identifier for the customer identity in Smile.

Example:

863291377

first_name

string | null

The first name of the customer in the external system.

Example:

"Jane"

last_name

string | null

The last name of the customer in the external system.

Example:

"Doe"

string<email>

The email of the customer in the external system.

Example:

"jane@doe.com"

distinct_id

string

The unique identifier for the customer in the external system.

Example:

"cust_19238475"

properties

object

A restricted hash of additional attributes for the customer identity. Keys are allowlisted on a per-integration basis.

customer_id

integer

The ID of the customer in Smile that this customer identity is linked to.

⌘I

REST API

API resources