sendgrid v2.0.0 SendGrid.Contacts.Lists View Source

Module to interact with modifying email lists.

See SendGrid’s Contact API Docs for more detail.

Link to this section Summary

Creates an email list

Adds a recipient to an email list

Retrieves all email lists

Retrieves all recipients from an email list

Deletes a recipient from an email list

add(list_name, opts \\ [])

add(String.t(), [SendGrid.api_key()]) :: {:ok, map()} | {:error, :any}

Creates an email list.

add_recipient(list_id, recipient_id, opts \\ [])

add_recipient(integer(), String.t(), [SendGrid.api_key()]) ::
  :ok | {:error, any()}

Adds a recipient to an email list.

all(opts \\ [])

all([SendGrid.api_key()]) :: {:ok[map(:ok, map())} | {:error, any()}

Retrieves all email lists.

all_recipients(list_id, opts \\ [])

all_recipients(integer(), [
  SendGrid.api_key() | SendGrid.page() | SendGrid.page_size()
]) :: {:ok[map(:ok, map())} | {:error, any()}

Retrieves all recipients from an email list.

delete_recipient(list_id, recipient_id, opts \\ [])

delete_recipient(integer(), String.t(), [SendGrid.api_key()]) ::
  :ok | {:error, any()}

Deletes a recipient from an email list.