Klaviyo.List (klaviyo v2.1.1)

Link to this section Summary

Functions

add_as_member(list_id, params)

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

add_as_subscriber(list_id, params)

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

all()

Returns an array of lists.

all_exclusions(list_id, params \\ %{})

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

all_group_members(list_id_or_segment_id, params \\ %{})

Get all emails in a given list or segment.

create(params)

Create a list.

delete(list_id)

Delete a list.

get(list_id)

Retrieve a list.

get_memberships(list_id, params)

Get people that are on a list.

get_subscriptions(list_id, params)

Get people that are on a list and not suppressed.

remove_as_member(list_id, params)

Remove members from a list

remove_as_subscriber(list_id, params)

Remove subscribers from a list.

update(list_id, params)

Update a list.

Link to this section Functions

add_as_member(list_id, params)

Specs

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

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

add_as_subscriber(list_id, params)

Specs

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.

all()

Specs

all() :: Klaviyo.Operation.t()

Returns an array of lists.

all_exclusions(list_id, params \\ %{})

Specs

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.

all_group_members(list_id_or_segment_id, params \\ %{})

Specs

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

Get all emails in a given list or segment.

create(params)

Specs

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

Create a list.

delete(list_id)

Specs

delete(String.t()) :: Klaviyo.Operation.t()

Delete a list.

get(list_id)

Specs

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

Retrieve a list.

get_memberships(list_id, params)

Specs

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

Get people that are on a list.

get_subscriptions(list_id, params)

Specs

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

Get people that are on a list and not suppressed.

remove_as_member(list_id, params)

Remove members from a list

remove_as_subscriber(list_id, params)

Specs

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

Remove subscribers from a list.

update(list_id, params)

Specs

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

Update a list.