Skip to main content

Documentation Index

Fetch the complete documentation index at: https://dev.smile.io/llms.txt

Use this file to discover all available pages before exploring further.

The customer represents an individual in the loyalty program who has a points balance, can earn points by performing activities, and can redeem points for rewards.
​
id
integer

Unique identifier for the customer in Smile.

Example:

304169228

​
firstName
string

The customer's first name.

Example:

"Jane"

​
lastName
string

The customer's last name.

Example:

"Doe"

​
email
string

The customer's email address.

Example:

"jane@doe.com"

​
state
string

The customer's state in the loyalty program. Possible values:

  • candidate - An individual that has not yet joined the loyalty program. Depending on program settings, they may or may not earn points.
  • member - An active loyalty program participant.
  • disabled - An individual that has been excluded from the program and cannot earn or redeem rewards.
Example:

"member"

​
dateOfBirth
string

The customer's birthday. A year value of 1004 means only the customer's birth day and month is available.

Example:

"1004-05-27"

​
referralUrl
string

The customer's unique referral URL. Used to share with friends as part of the referral program.

Example:

"http://i.refs.cc/9qr5Pw"

​
createdAt
string<date-time>

The date and time when the customer was created.

Example:

"2024-04-04T15:10:42.030Z"

​
updatedAt
string<date-time>

The date and time when the customer was last updated.

Example:

"2024-04-04T15:10:42.030Z"