Module: ActiveCampaign::API::Lists

Defined in:
lib/active_campaign/api/lists.rb

Overview

Interface to list endpoints

Author:

Instance Method Summary collapse

Instance Method Details

#create_list(params) ⇒ Hash

Create a new list

Parameters:

  • params (Hash) —

    create a new list with this data

Options Hash (params):

  • :name (String) —

    REQUIRED Name of the list to create

  • :stringid (String) —

    REQUIRED URL-safe list name. Example: 'list-name-sample'

  • :sender_url (String) —

    REQUIRED The website URL this list is for.

  • :sender_reminder (String) —

    REQUIRED A reminder for your contacts as to why they are on this list and you are messaging them

  • :send_last_broadcast (true, false) —

    Boolean value indicating whether or not to send the last sent campaign to this list to a new subscriber upon subscribing. 1 = yes, 0 = no

  • :carboncopy (String) —

    Comma-separated list of email addresses to send a copy of all mailings to upon send

  • :subscription_notify (String) —

    Comma-separated list of email addresses to notify when a new subscriber joins this list

  • :unsubscription_notify (String) —

    Comma-separated list of email addresses to notify when a subscriber unsubscribes from this list

  • :user (Integer) —

    User Id of the list owner. A list owner is able to control campaign branding. A property of list.userid also exists on this object; both properties map to the same list owner field and are being maintained in the response object for backward compatibility. If you post values for both list.user and list.userid, the value of list.user will be used.

Returns:

  • (Hash) —

    a hash with information about the newly created list



35
36
37
 
# File 'lib/active_campaign/api/lists.rb', line 35

def create_list(params)
  post('lists', list: params)
end

#delete_list(id) ⇒ Hash

Deletes a list with given id

Parameters:

  • id (String) —

    the id of a list to delete

Returns:

  • (Hash) 


68
69
70
 
# File 'lib/active_campaign/api/lists.rb', line 68

def delete_list(id)
  delete("lists/#{id}")
end

#show_list(id) ⇒ Hash

Get a single list

Parameters:

  • id (Integer) —

    the id of a list to show

Returns:

  • (Hash) 


46
47
48
 
# File 'lib/active_campaign/api/lists.rb', line 46

def show_list(id)
  get("lists/#{id}")
end

#show_lists(search = nil) ⇒ Array<Hash>

Get a list of lists

Parameters:

  • search (String) (defaults to: nil) —

    Filter lists that match the given value in the list attributes

Returns:

  • (Array<Hash>) 


57
58
59
 
# File 'lib/active_campaign/api/lists.rb', line 57

def show_lists(search = nil)
  get('lists', search: search)
end