View Source ActiveCampaign.Contact (active_campaign v0.3.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 contacts
examples
Examples
iex> contacts = [
%{
email: "oscar.b@example.com",
subscribe: [
%{listid: 26}
]
}
]
iex> callback = %{
url: "https://example.com/webhooks/active-campaign/bulk-import",
requestType: "POST",
detailed_results: "false",
params: [
%{key: "param-key", value: "param-value"}
],
headers: [
%{key: "header-key", value: "header-value"}
]
}
iex> ActiveCampaign.Contact.bulk_import(contacts, callback)
{:ok,
%{
"batchId" => "e496235c-e7c4-4c8c-80ee-61975e9dc7f8",
"message" => "Contact import queued",
"queued_contacts" => 250,
"success" => 1
}}
Bulk import status info
Bulk import status list
examples
Examples
iex> ActiveCampaign.Contact.bulk_import_status_list()
{:ok, %{"outstanding" => [], "recentlyCompleted" => []}}
Create a contact
examples
Examples
iex> ActiveCampaign.Contact.create(%{
email: "johndoe@example.com",
firstName: "John",
lastName: "Doe",
phone: "7223224241"
})
{:ok, %{"contact" => %{...}}}
Delete a contact
Retrieve a contact
examples
Examples
iex> ActiveCampaign.Contact.get(123)
{:ok, %{"contactAutomations" => [...], "contactLists" => [...], ...}}
Retrieve a contacts account contacts
examples
Examples
iex> ActiveCampaign.Contact.get_account_contacts(123)
{:ok, %{"accountContacts" => []}}
Retrieve a contacts automation entry counts
examples
Examples
iex> ActiveCampaign.Contact.get_automation_entry_counts(123)
{:ok, %{"automationEntryCounts" => []}}
Retrieve a contact's bounce logs
examples
Examples
iex> ActiveCampaign.Contact.get_bounce_logs(123)
{:ok, %{"bounceLogs" => []}}
Retrieve a list of contact's deals
examples
Examples
iex> ActiveCampaign.Contact.get_contact_deals(123)
{:ok, %{"contactDeals" => []}}
Retrieve a contact's data
examples
Examples
iex> ActiveCampaign.Contact.get_data(123)
{:ok, %{"contactDatum" => %{...}}}
Retrieve a contact's deals
examples
Examples
iex> ActiveCampaign.Contact.get_deals(123)
{:ok, %{"deals" => []}}
Retrieve a contact's field values
examples
Examples
iex> ActiveCampaign.Contact.get_deals(123)
{:ok, %{"fieldValues" => []}}
Retrieve a contacts geo ips
examples
Examples
iex> ActiveCampaign.Contact.get_geo_ips(123)
{:ok, %{"geoIps" => []}}
Retrieve a contact's goals
examples
Examples
iex> ActiveCampaign.Contact.get_goals(123)
{:ok, %{"contactGoals" => []}}
Retrieve a contact's list memberships
examples
Examples
iex> ActiveCampaign.Contact.get_list_memberships(123)
{:ok, %{"contactLists" => []}}
Retrieve a contact's logs
examples
Examples
iex> ActiveCampaign.Contact.get_logs(123)
{:ok, %{"contactLogs" => []}}
Retrieve a contacts notes
examples
Examples
iex> ActiveCampaign.Contact.get_notes(123)
{:ok, %{"notes" => []}}
Retrieve a contacts organization
Retrieve a contacts plus append
examples
Examples
iex> ActiveCampaign.Contact.get_plus_append(123)
{:ok, %{}}
Retrieve a contact's score value
Retrieve a contacts tracking logs
examples
Examples
iex> ActiveCampaign.Contact.get_tracking_logs(123)
{:ok, %{"trackingLogs" => []}}
List all contact activities
List all automations the contact is in
List, search, and filter contacts
Sync a contact's data
Update a contact
iex> ActiveCampaign.Contact.update(123, %{email: "john@example.com"}) {:ok, %{"contact" => %{...}}
Update list status for a contact
examples
Examples
iex> AC.Contact.update_list_status(%{list: 1, contact: 22, status: ActiveCampaign.Contact.Status.active()})
{:ok, %{"contactList" => %{...}, "contacts" => [...]}}