ExCampaignMonitor v0.8.0 ExCampaignMonitor.Lists View Source

Covers all your list management needs

Provide your Campaign Monitor Client ID to use this module:

config :ex_campaign_monitor, :client_id, "YOUR_CLIENT_ID"

Link to this section Summary

Functions

Activate a webhook for a List

Create a new list

Delete a webhook for a list

Get a list with active subscribers

Get details of a specific list by ListID

Get a list of all webhooks for a List

Link to this section Functions

Link to this function activate_webhook(list_id, webhook_id) View Source
activate_webhook(String.t(), String.t()) :: :ok | {:error, String.t()}

Activate a webhook for a List

Create a new list

Must provide a :title, and optionally:

  • :unsubscribe_page
  • :unsubscribe_setting
  • :confirmed_opt_in
  • :confirmation_success_page
Link to this function create_webhook(list_id, events, url, payload_format \\ "json") View Source
create_webhook(String.t(), [String.t()], String.t(), String.t()) ::
  {:ok, String.t()} | {:error, String.t()}

Create a webhook for a list

Link to this function delete_webhook(list_id, webhook_id) View Source
delete_webhook(String.t(), String.t()) :: {:ok, Atom.t()} | {:error, String.t()}

Delete a webhook for a list

Link to this function get_active_subscribers(list_id) View Source
get_active_subscribers(String.t()) ::
  {:ok, ExCampaignMonitor.List.t()} | {:error, String.t()}

Get a list with active subscribers

Link to this function get_list_by_id(list_id) View Source
get_list_by_id(String.t()) ::
  {:ok, ExCampaignMonitor.List.t()} | {:error, String.t()}

Get details of a specific list by ListID

Link to this function list_webhooks(list_id) View Source
list_webhooks(String.t()) :: {:ok, list()} | {:error, String.t()}

Get a list of all webhooks for a List