klaviyo v2.0.0 Klaviyo.List

Link to this section Summary

Functions

Add people to a list without changing their subscription or suppression status.

Add people to a list in addition to modifying their membership and updating their suppressions.

Returns an array of lists.

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

Get all emails in a given list or segment.

Create a list.

Delete a list.

Retrieve a list.

Get people that are on a list.

Get people that are on a list and not suppressed.

Remove members from a list

Remove subscribers from a list.

Update a list.

Link to this section Functions

Link to this function

add_as_member(list_id, params)

add_as_member(String.t(), map()) :: Klaviyo.Operation.t()

Add people to a list without changing their subscription or suppression status.

Link to this function

add_as_subscriber(list_id, params)

add_as_subscriber(String.t(), map()) :: Klaviyo.Operation.t()

Add people to a list in addition to modifying their membership and updating their suppressions.

People will be single or double opted into the specified list in accordance with that list's settings.

Returns an array of lists.

Link to this function

all_exclusions(list_id, params \\ %{})

all_exclusions(String.t(), map()) :: Klaviyo.Operation.t()

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

Link to this function

all_group_members(list_id_or_segment_id, params \\ %{})

all_group_members(String.t(), map()) :: Klaviyo.Operation.t()

Get all emails in a given list or segment.

Link to this function

create(params)

create(map()) :: Klaviyo.Operation.t()

Create a list.

Delete a list.

Retrieve a list.

Link to this function

get_memberships(list_id, params)

get_memberships(String.t(), map()) :: Klaviyo.Operation.t()

Get people that are on a list.

Link to this function

get_subscriptions(list_id, params)

get_subscriptions(String.t(), map()) :: Klaviyo.Operation.t()

Get people that are on a list and not suppressed.

Link to this function

remove_as_member(list_id, params)

Remove members from a list

Link to this function

remove_as_subscriber(list_id, params)

remove_as_subscriber(String.t(), map()) :: Klaviyo.Operation.t()

Remove subscribers from a list.

Link to this function

update(list_id, params)

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

Update a list.