ExChimp.List (ExChimp v0.2.0)

View Source

List-oriented API calls.

Summary

Types

member_status()

@type member_status() :: :subscribed | :unsubscribed | :cleaned | :pending

Functions

add_member(api_key, list_id, status, email)

@spec add_member(binary(), binary(), member_status(), binary()) ::
  {:ok, map()} | {:error, binary()}

add_member(api_key, list_id, status, email, merge_fields, other_fields \\ %{})

@spec add_member(binary(), binary(), member_status(), binary(), map(), map()) ::
  {:ok, map()} | {:error, binary()}

all(api_key)

@spec all(binary()) :: {:ok, [map()]}

destroy_member(api_key, list_id, email)

@spec destroy_member(binary(), binary(), binary()) ::
  {:ok, map()} | {:error, binary()}

members(api_key, list_id)

@spec members(binary(), binary()) :: {:ok, map()} | {:error, binary()}