Netzo

🇺🇸 EN

🇪🇸 ES

🇺🇸 EN

🇪🇸 ES

Appearance

On this page
netzo/apis/activecampaign

ActiveCampaign ​

ActiveCampaign is a marketing automation platform that helps you create personalized experiences for your customers across every channel.

  • labels: sales, marketing, communication/email, customer-service
  • authentication: apiKey

Usage ​

ts
import { activecampaign } from 'https://deno.land/x/netzo/apis/activecampaign/mod.ts'

const { api } = activecampaign({
  accountName: Deno.env.get('ACTIVECAMPAIGN_ACCOUNT_NAME'),
  apiKey: Deno.env.get('ACTIVECAMPAIGN_API_KEY'),
})
import { activecampaign } from 'https://deno.land/x/netzo/apis/activecampaign/mod.ts'

const { api } = activecampaign({
  accountName: Deno.env.get('ACTIVECAMPAIGN_ACCOUNT_NAME'),
  apiKey: Deno.env.get('ACTIVECAMPAIGN_API_KEY'),
})

Configuration ​

The activecampaign factory function expects an object with the following, and returns an object with an HTTP client api.

ParamTypeDefaultDescription
apiKeystringDeno.env.get('ACTIVECAMPAIGN_API_KEY')the api key to use for authentication
accountNamestringDeno.env.get('ACTIVECAMPAIGN_ACCOUNT_NAME')the name of the account

Refer to the API documentation to get the required information.

Examples ​

The following examples assume you have created an api client instance. Refer to the type definitions for all exported types to pass to the api client for typed responses.

Find contacts ​

Find all contacts that match the query.

ts
import type { Contacts, QueryContacts } from 'netzo/apis/activecampaign/types.ts'

const query: QueryContacts = {}
const result = await api.contacts.get<Contacts>(query)
const resultData = result.contacts
import type { Contacts, QueryContacts } from 'netzo/apis/activecampaign/types.ts'

const query: QueryContacts = {}
const result = await api.contacts.get<Contacts>(query)
const resultData = result.contacts

Get contact ​

Get a contact by id.

ts
import type { Contact } from 'netzo/apis/activecampaign/types.ts'

const resultData = await api.contacts[CONTACT_ID].get<Contact>()
import type { Contact } from 'netzo/apis/activecampaign/types.ts'

const resultData = await api.contacts[CONTACT_ID].get<Contact>()

Add contact ​

Add a new contact.

ts
import type { AddOrUpdateContactResult, DataAddContact } from 'netzo/apis/activecampaign/types.ts'

const data: DataAddContact = {
  contact: {
    email: '[email protected]'
  }
}
const resultData = await api.contacts.post<AddOrUpdateContactResult>(data)
import type { AddOrUpdateContactResult, DataAddContact } from 'netzo/apis/activecampaign/types.ts'

const data: DataAddContact = {
  contact: {
    email: '[email protected]'
  }
}
const resultData = await api.contacts.post<AddOrUpdateContactResult>(data)

Update contact ​

Update a contact by id.

ts
import type { AddOrUpdateContactResult, DataUpdateContact } from 'netzo/apis/activecampaign/types.ts'

const data: DataUpdateContact = {
  contact: {
    email: '[email protected]'
  }
}
const resultData = await api.contacts[CONTACT_ID].put<AddOrUpdateContactResult>(data)
import type { AddOrUpdateContactResult, DataUpdateContact } from 'netzo/apis/activecampaign/types.ts'

const data: DataUpdateContact = {
  contact: {
    email: '[email protected]'
  }
}
const resultData = await api.contacts[CONTACT_ID].put<AddOrUpdateContactResult>(data)

Delete contact ​

Delete a contact by id.

ts
const resultData = await api.contacts[CONTACT_ID].delete<{}>()
const resultData = await api.contacts[CONTACT_ID].delete<{}>()

Find deals ​

Find all deals with optional filtering.

ts
import type { Deals, FilterDeals } from 'netzo/apis/activecampaign/types.ts'

const query: FilterDeals = {}
const result = await api.deals.get<Deals>(query)
const resultData = result.deals
import type { Deals, FilterDeals } from 'netzo/apis/activecampaign/types.ts'

const query: FilterDeals = {}
const result = await api.deals.get<Deals>(query)
const resultData = result.deals

Find accounts ​

Find all accounts, or specify a name in the search field.

ts
import type { Accounts, QueryAccounts } from 'netzo/apis/activecampaign/types.ts'

const query: QueryAccounts = {}
const result = await api.accounts.get<Accounts>(query)
const resultData = result.accounts
import type { Accounts, QueryAccounts } from 'netzo/apis/activecampaign/types.ts'

const query: QueryAccounts = {}
const result = await api.accounts.get<Accounts>(query)
const resultData = result.accounts

Find users ​

Find all users of the account.

ts
import type { Users } from 'netzo/apis/activecampaign/types.ts'

const result = await api.users.get<Users>()
const resultData = result.users
import type { Users } from 'netzo/apis/activecampaign/types.ts'

const result = await api.users.get<Users>()
const resultData = result.users

Add user ​

Add a new user to the account.

ts
import type { AddUserResult, DataAddUser } from 'netzo/apis/activecampaign/types.ts'

const data: DataAddUser = {
  user: {
    username: 'jsmith'
  }
}
const result = await api.users.post<AddUserResult>(data)
const resultData = result.user
import type { AddUserResult, DataAddUser } from 'netzo/apis/activecampaign/types.ts'

const data: DataAddUser = {
  user: {
    username: 'jsmith'
  }
}
const result = await api.users.post<AddUserResult>(data)
const resultData = result.user

References ​

Copyright © 2023 Netzo