Module: ActiveCampaign::API::Contacts

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

Overview

Interface to contact endpoints

Author:

Instance Method Summary collapse

Instance Method Details

#create_contact(params) ⇒ Hash

Create a new contact

Parameters:

  • params (Hash) —

    create a new contact with this data

Options Hash (params):

  • :email (String) —

    the contacts email

  • :first_name (String) —

    the first name of the contact

  • :last_name (String) —

    the last name of the contact

  • :phone (String) —

    the number to call the contact with

Returns:

  • (Hash) —

    a hash with information about the newly created contact



22
23
24
 
# File 'lib/active_campaign/api/contacts.rb', line 22

def create_contact(params)
  post('contacts', contact: params)
end

#delete_contact(id) ⇒ Hash

Deletes a contact with given id

Parameters:

  • id (Integer) —

    the id of a contact to delete

Returns:

  • (Hash) 


101
102
103
 
# File 'lib/active_campaign/api/contacts.rb', line 101

def delete_contact(id)
  delete("contacts/#{id}")
end

#show_contact(id) ⇒ Hash

Get a single contact

Parameters:

  • id (Integer) —

    the id of a contact to show

Returns:

  • (Hash) 


33
34
35
 
# File 'lib/active_campaign/api/contacts.rb', line 33

def show_contact(id)
  get("contacts/#{id}")
end

#show_contacts(filters: {}, orders: {}, **params) ⇒ Hash

Get a list of contacts

Parameters:

  • params (Hash)
  • filters (Hash) (defaults to: {}) —

    a list of filters

  • orders (Hash) (defaults to: {}) —

    a list of filters by orders

Options Hash (filters:):

  • :created_before (Date) —

    Filter contacts that were created prior to this date

  • :created_after (Date) —

    Filter contacts that were created after this date

  • :updated_before (Date) —

    Filter contacts that were updated before this date

  • :updated_after (String) —

    Filter contacts that were updated after this date

  • :waitid (Integer) —

    Filter by contacts in the wait queue of an automation block

Options Hash (orders:):

  • :cdate (String) —

    Order contacts by creation date

  • :email (String) —

    Order contacts by email

  • :first_name (String) —

    Order contacts by first name

  • :last_name (String) —

    Order contacts by last name

  • :name (String) —

    Order contacts by full name

  • :score (String) —

    Order contacts by score

  • :in_group_lists (String) —

    "true" to return only contacts the user has permissions to see.

Options Hash (**params):

  • param (String) —

    :ids Filter contacts by ID. Can be repeated for multiple IDs. Example: ids: [42, 43, 1]

  • :datetime (Date) —

    Contacts created on the specified date

  • :email (String) —

    Email address of the contact you want to get

  • :email_like (String) —

    Filter contacts that contain the given value in the email address

  • :exclude (Integer) —

    Exclude from the response the contact with the given ID

  • :formid (Integer) —

    Filter contacts associated with the given form

  • :id_greater (Integer) —

    Only include contacts with an ID greater than the given ID

  • :id_less (Integer) —

    Only include contacts with an ID less than the given ID

  • :listid (String) —

    Filter contacts associated with the given list

  • :search (String) —

    Filter contacts that match the given value in the contact attributes

  • :segmentid (Integer) —

    Return only contacts that match a list segment

  • :seriesid (Integer) —

    Filter contacts associated with the given automation

  • :status (Integer) —

    See available values

  • :tagid (Integer) —

    Filter contacts associated with the given tag

Returns:

  • (Hash) 


87
88
89
90
91
92
 
# File 'lib/active_campaign/api/contacts.rb', line 87

def show_contacts(filters: {}, orders: {}, **params)
  params[:filters] = filters if filters.any?
  params[:orders]  = orders  if orders.any?

  get('contacts', params)
end

#sync_contact(params) ⇒ Hash

Sync an existing contact or create a new one

Parameters:

  • params (Hash) —

    create a new contact with this data

Options Hash (params):

  • :email (String) —

    the contacts email

  • :first_name (String) —

    the first name of the contact

  • :last_name (String) —

    the last name of the contact

  • :phone (String) —

    the number to call the contact with

Returns:

  • (Hash) —

    a hash with information about the newly created contact



48
49
50
 
# File 'lib/active_campaign/api/contacts.rb', line 48

def sync_contact(params)
  post('contact/sync', contact: params)
end

#update_contact(id, params) ⇒ Hash

Update an existing contact with given id

Parameters:

  • id (Integer) —

    the id of a contact to update

  • params (Hash) —

    create a new contact with this data

Options Hash (params):

  • :email (String) —

    the contacts email

  • :first_name (String) —

    the first name of the contact

  • :last_name (String) —

    the last name of the contact

  • :phone (String) —

    the number to call the contact with

Returns:

  • (Hash) —

    a hash with information about the newly created contact



117
118
119
 
# File 'lib/active_campaign/api/contacts.rb', line 117

def update_contact(id, params)
  put("contacts/#{id}", contact: params)
end