Klaviyo.List (klaviyo v2.3.0)
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
add_as_member(list_id, params)
@spec 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)
@spec 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()
@spec all() :: Klaviyo.Operation.t()
Returns an array of lists.
all_exclusions(list_id, params \\ %{})
@spec 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 \\ %{})
@spec all_group_members(String.t(), map()) :: Klaviyo.Operation.t()
Get all emails in a given list or segment.
create(params)
@spec create(map()) :: Klaviyo.Operation.t()
Create a list.
delete(list_id)
@spec delete(String.t()) :: Klaviyo.Operation.t()
Delete a list.
get(list_id)
@spec get(String.t()) :: Klaviyo.Operation.t()
Retrieve a list.
get_memberships(list_id, params)
@spec get_memberships(String.t(), map()) :: Klaviyo.Operation.t()
Get people that are on a list.
get_subscriptions(list_id, params)
@spec 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)
@spec remove_as_subscriber(String.t(), map()) :: Klaviyo.Operation.t()
Remove subscribers from a list.
update(list_id, params)
@spec update(String.t(), map()) :: Klaviyo.Operation.t()
Update a list.