Klaviyo.Person (klaviyo v2.3.0)

Link to this section Summary

Functions

Exchange an encrypted identifier for a profile ID.

Retrieve a person.

Retrieve a person's Klaviyo ID.

Returns a batched timeline of all events.

Reeturns a batched timline of all events for one specific type of metric.

Add or update one or more attributes.

Link to this section Functions

Link to this function

exchange(exchange_id)

@spec exchange(String.t()) :: Klaviyo.Operation.t()

Exchange an encrypted identifier for a profile ID.

@spec get(String.t()) :: Klaviyo.Operation.t()

Retrieve a person.

@spec search(map()) :: Klaviyo.Operation.t()

Retrieve a person's Klaviyo ID.

Link to this function

timeline(person_id, params \\ %{})

@spec timeline(String.t(), map()) :: Klaviyo.Operation.t()

Returns a batched timeline of all events.

Link to this function

timeline_for_type(person_id, metric_id, params \\ %{})

@spec timeline_for_type(String.t(), String.t(), map()) :: Klaviyo.Operation.t()

Reeturns a batched timline of all events for one specific type of metric.

Link to this function

update(person_id, params)

@spec update(String.t(), map()) :: Klaviyo.Operation.t()

Add or update one or more attributes.

If an attribute already exists it will be updated. If an attribute does not exist it will be added.