klaviyo

v1.0.0

klaviyo v1.0.0 Klaviyo.List

Provides support for the Klaviyo Lists API.

This module provides access to all known endpoints of the v2 Lists API.

Link to this section Summary

Functions

add_profiles(id, params)

Add profiles to a list

check_for_profile(id, params)

Check if profiles are on a list

check_subscription(id, params)

Check if profiles are on a list and not suppressed

create(params)

Create a list

delete(id)

Delete a list

exclusions(id, params \\ %{})

Get all emails that have been excluded from a list along with the exclusion reason and exclusion time

group_membership_emails(id, params \\ %{})

Get all emails in a given list or segment

list()

Get a list of all lists

remove_profiles(id, params)

Remove profiles from a list

retrieve(id)

Retrieve information about a list

subscribe(id, params)

Subscribe or re-subscribe profiles to a list

unsubscribe(id, params)

Unsubscribe and remove profiles from a list

update(id, params)

Update the properties of a list

Link to this section Functions

Link to this function add_profiles(id, params) 
add_profiles(String.t(), list()) :: Klaviyo.Operation.t()

Add profiles to a list.

Link to this function check_for_profile(id, params) 
check_for_profile(String.t(), list()) :: Klaviyo.Operation.t()

Check if profiles are on a list.

Link to this function check_subscription(id, params) 
check_subscription(String.t(), list()) :: Klaviyo.Operation.t()

Check if profiles are on a list and not suppressed.

Link to this function create(params) 
create(map()) :: Klaviyo.Operation.t()

Create a list.

Link to this function delete(id) 
delete(String.t()) :: Klaviyo.Operation.t()

Delete a list.

Link to this function exclusions(id, params \\ %{}) 
exclusions(String.t(), map()) :: Klaviyo.Operation.t()

Get all emails that have been excluded from a list along with the exclusion reason and exclusion time.

Link to this function group_membership_emails(id, params \\ %{}) 
group_membership_emails(String.t(), map()) :: Klaviyo.Operation.t()

Get all emails in a given list or segment.

Link to this function list() 
list() :: Klaviyo.Operation.t()

Get a list of all lists.

Link to this function remove_profiles(id, params) 
remove_profiles(String.t(), list()) :: Klaviyo.Operation.t()

Remove profiles from a list.

Link to this function retrieve(id) 
retrieve(String.t()) :: Klaviyo.Operation.t()

Retrieve information about a list.

Link to this function subscribe(id, params) 
subscribe(String.t(), list()) :: Klaviyo.Operation.t()

Subscribe or re-subscribe profiles to a list.

Link to this function unsubscribe(id, params) 
unsubscribe(String.t(), list()) :: Klaviyo.Operation.t()

Unsubscribe and remove profiles from a list.

Link to this function update(id, params) 
update(String.t(), map()) :: Klaviyo.Operation.t()

Update the properties of a list.