ActiveCampaign.Contact (active_campaign v0.1.0)
Documentation for ActiveCampaign.Contact
.
Link to this section Summary
Functions
Bulk import contacts
Bulk import status info
Bulk import status list
Create a contact
Delete a contact
Retrieve a contact
Retrieve a contacts account contacts
Retrieve a contacts automation entry counts
Retrieve a contact's bounce logs
Retrieve a list of contact's deals
Retrieve a contact's data
Retrieve a contact's deals
Retrieve a contact's field values
Retrieve a contacts geo ips
Retrieve a contact's goals
Retrieve a contact's list memberships
Retrieve a contact's logs
Retrieve a contacts notes
Retrieve a contacts organization
Retrieve a contacts plus append
Retrieve a contact's score value
Retrieve a contacts tracking logs
List all contact activities
List all automations the contact is in
List, search, and filter contacts
Sync a contact's data
Update a contact
Update list status for a contact
Link to this section Functions
bulk_import()
Bulk import contacts
bulk_import_status_info(data \\ [])
Bulk import status info
bulk_import_status_list()
Bulk import status list
examples
Examples
iex> ActiveCampaign.Contact.bulk_import_status_list()
{:ok, %{"outstanding" => [], "recentlyCompleted" => []}}
create(data)
Create a contact
examples
Examples
iex> ActiveCampaign.Contact.create(%{
email: "johndoe@example.com",
firstName: "John",
lastName: "Doe",
phone: "7223224241"
})
{:ok, %{"contact" => %{...}}}
delete(id)
Delete a contact
get(id)
Retrieve a contact
examples
Examples
iex> ActiveCampaign.Contact.get(123)
{:ok, %{"contactDatum" => %{...}}}
get_account_contacts(id)
Retrieve a contacts account contacts
examples
Examples
iex> ActiveCampaign.Contact.get_account_contacts(123)
{:ok, %{"accountContacts" => []}}
get_automation_entry_counts(id)
Retrieve a contacts automation entry counts
examples
Examples
iex> ActiveCampaign.Contact.get_automation_entry_counts(123)
{:ok, %{"automationEntryCounts" => []}}
get_bounce_logs(id)
Retrieve a contact's bounce logs
examples
Examples
iex> ActiveCampaign.Contact.get_bounce_logs(123)
{:ok, %{"bounceLogs" => []}}
get_contact_deals(id)
Retrieve a list of contact's deals
examples
Examples
iex> ActiveCampaign.Contact.get_contact_deals(123)
{:ok, %{"contactDeals" => []}}
get_data(id)
Retrieve a contact's data
examples
Examples
iex> ActiveCampaign.Contact.get_data(123)
{:ok, %{"contactDatum" => %{...}}}
get_deals(id)
Retrieve a contact's deals
examples
Examples
iex> ActiveCampaign.Contact.get_deals(123)
{:ok, %{"deals" => []}}
get_field_values(id)
Retrieve a contact's field values
examples
Examples
iex> ActiveCampaign.Contact.get_deals(123)
{:ok, %{"fieldValues" => []}}
get_geo_ips(id)
Retrieve a contacts geo ips
examples
Examples
iex> ActiveCampaign.Contact.get_geo_ips(123)
{:ok, %{"geoIps" => []}}
get_goals(id)
Retrieve a contact's goals
examples
Examples
iex> ActiveCampaign.Contact.get_goals(123)
{:ok, %{"contactGoals" => []}}
get_list_memberships(id)
Retrieve a contact's list memberships
examples
Examples
iex> ActiveCampaign.Contact.get_list_memberships(123)
{:ok, %{"contactLists" => []}}
get_logs(id)
Retrieve a contact's logs
examples
Examples
iex> ActiveCampaign.Contact.get_logs(123)
{:ok, %{"contactLogs" => []}}
get_notes(id)
Retrieve a contacts notes
examples
Examples
iex> ActiveCampaign.Contact.get_notes(123)
{:ok, %{"notes" => []}}
get_organization(id)
Retrieve a contacts organization
get_plus_append(id)
Retrieve a contacts plus append
examples
Examples
iex> ActiveCampaign.Contact.get_plus_append(123)
{:ok, %{}}
get_score(id)
Retrieve a contact's score value
get_tracking_logs(id)
Retrieve a contacts tracking logs
examples
Examples
iex> ActiveCampaign.Contact.get_tracking_logs(123)
{:ok, %{"trackingLogs" => []}}
list_activity(data)
List all contact activities
%{ contact: integer(), after: Date.t(), include: String.t(), emails: boolean(), orders: %{
tstamp: ASC
} }
examples
Examples
iex> ActiveCampaign.Contact.update_list_status(contact: 123)
{:ok, %{"activities" => [], "meta" => %{"total" => "0"}}}
list_automations(id)
List all automations the contact is in
search(data)
List, search, and filter contacts
sync(data)
Sync a contact's data
update(id, data)
Update a contact
update_list_status(data)
Update list status for a contact
examples
Examples
iex> ActiveCampaign.Contact.update_list_status(%{
list: 2,
contact: 1,
status: 1
})
# FIXME
{:ok, %{"message" => "Updated"}}