Skip to main content
Activities represent actions performed by customers in the loyalty program. They are used to determine when rewards should be issued, track customer behavior, and personalize the customer experience.
​
id
integer

Unique identifier for the activity.

Example:

503256787

​
customer_id
integer

The ID of the customer who performed the activity.

Example:

304169228

​
token
string

A token identifying the activity that was performed.

Example:

"activity_f57a9b5a8d0ac5"

​
properties
object

An arbitrary hash of additional information related to the activity.

​
distinct_id
string

A unique identifier for the activity in the external system (e.g. the order number). When provided, it must be unique among activities with the same token. Creating a second activity with the same token and distinct_id will fail, preventing duplicates.

Example:

"212993"

​
created_on_origin_at
string<date-time>

The date and time the activity was performed by the customer in the external system. Defaults to the activity's created_at date when not explicitly specified.

Example:

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

​
updated_on_origin_at
string<date-time>

The date and time the activity was last updated outside of Smile.

Example:

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

​
created_at
string<date-time>

The date and time when the activity was created.

Example:

"2024-05-15T08:35:08.920Z"

​
updated_at
string<date-time>

The date and time when the activity was last updated.

Example:

"2024-05-15T08:35:08.920Z"