Active Campaign¶

Node: activeCampaign · Full type: n8n-nodes-base.activeCampaign · Version: 1

Credentials¶

activeCampaignApi (alias: @active)

CREDENTIAL @active = activeCampaignApi "My Active Campaign"

Operations¶

Resource: `account`¶

`create`¶

Parameter	Type	Default	Details
`name`	string	""	required
`additionalFields`	collection	{}	keys: `accountUrl`, `fields`

`delete`¶

Parameter	Type	Default	Details
`accountId`	number	0	required

`get`¶

Parameter	Type	Default	Details
`accountId`	number	0	required

`getAll`¶

Parameter	Type	Default	Details
`returnAll`	boolean	false
`limit`	number	100
`simple`	boolean	true
`filters`	collection	{}	keys: `search`

`update`¶

Parameter	Type	Default	Details
`accountId`	number	0	required
`updateFields`	collection	{}	keys: `name`, `accountUrl`, `fields`

Resource: `accountContact`¶

`create`¶

Parameter	Type	Default	Details
`account`	number	""	required
`contact`	number	""	required
`additionalFields`	collection	{}	keys: `jobTitle`

`delete`¶

Parameter	Type	Default	Details
`accountContactId`	number	0	required

`update`¶

Parameter	Type	Default	Details
`accountContactId`	number	""	required
`updateFields`	collection	{}	keys: `jobTitle`

Resource: `connection`¶

`create`¶

Parameter	Type	Default	Details
`service`	string	""	required
`externalid`	string	""	required
`name`	string	""	required
`logoUrl`	string	""	required
`linkUrl`	string	""	required

`delete`¶

Parameter	Type	Default	Details
`connectionId`	number	0	required

`get`¶

Parameter	Type	Default	Details
`connectionId`	number	0	required

`getAll`¶

Parameter	Type	Default
`returnAll`	boolean	false
`limit`	number	100
`simple`	boolean	true

`update`¶

Parameter	Type	Default	Details
`connectionId`	number	0	required
`updateFields`	collection	{}	keys: `service`, `externalid`, `name`, `logoUrl`, `linkUrl`, `status`, ...

Resource: `contact`¶

`create`¶

Parameter	Type	Default	Details
`email`	string	""	required
`updateIfExists`	boolean	false
`additionalFields`	collection	{}	keys: `fieldValues`, `firstName`, `lastName`, `phone`

`delete`¶

Parameter	Type	Default	Details
`contactId`	number	0	required

`get`¶

Parameter	Type	Default	Details
`contactId`	number	0	required

`getAll`¶

Parameter	Type	Default	Details
`returnAll`	boolean	false
`limit`	number	100
`simple`	boolean	true
`additionalFields`	collection	{}	keys: `datetime`, `email`, `email_like`, `exclude`, `formid`, `listid`, ...

`update`¶

Parameter	Type	Default	Details
`contactId`	number	0	required
`updateFields`	collection	{}	keys: `fieldValues`, `email`, `firstName`, `lastName`, `phone`

Resource: `contactList`¶

`add`¶

Parameter	Type	Default	Details
`listId`	number	""	required
`contactId`	number	""	required

`remove`¶

Parameter	Type	Default	Details
`listId`	number	""	required
`contactId`	number	""	required

Resource: `contactTag`¶

`add`¶

Parameter	Type	Default	Details
`tagId`	options	""	required
`contactId`	number	""	required

`remove`¶

Parameter	Type	Default	Details
`contactTagId`	number	0	required

Resource: `deal`¶

`create`¶

Parameter	Type	Default	Details
`title`	string	""	required
`contact`	number	0	required
`value`	number	0	required
`currency`	options	"eur"	required; `eur`, `usd`, `gbp`, `chf`, `cny`, `,aed`,`afn`, ... (171 total)
`group`	string	""
`stage`	string	""
`owner`	string	""
`additionalFields`	collection	{}	keys: `description`, `percent`, `status`

`createNote`¶

Parameter	Type	Default	Details
`dealId`	number	""	required
`dealNote`	string	""	required

`delete`¶

Parameter	Type	Default	Details
`dealId`	number	0	required

`get`¶

Parameter	Type	Default	Details
`dealId`	number	0	required

`getAll`¶

Parameter	Type	Default
`returnAll`	boolean	false
`limit`	number	100
`simple`	boolean	true

`update`¶

Parameter	Type	Default	Details
`dealId`	number	0	required
`updateFields`	collection	{}	keys: `title`, `contact`, `value`, `currency`, `description`, `group`, ...

`updateNote`¶

Parameter	Type	Default	Details
`dealId`	number	""	required
`dealNoteId`	number	""	required
`dealNote`	string	""

Resource: `ecommerceCustomer`¶

`create`¶

Parameter	Type	Default	Details
`connectionid`	string	""	required
`externalid`	string	""	required
`email`	string	""	required
`additionalFields`	collection	{}	keys: `acceptsMarketing`

`delete`¶

Parameter	Type	Default	Details
`ecommerceCustomerId`	number	0	required

`get`¶

Parameter	Type	Default	Details
`ecommerceCustomerId`	number	0	required

`getAll`¶

Parameter	Type	Default
`returnAll`	boolean	false
`limit`	number	100
`simple`	boolean	true

`update`¶

Parameter	Type	Default	Details
`ecommerceCustomerId`	number	0	required
`updateFields`	collection	{}	keys: `connectionid`, `externalid`, `email`, `acceptsMarketing`

Resource: `ecommerceOrder`¶

`create`¶

Parameter	Type	Default	Details
`externalid`	string	""
`externalcheckoutid`	string	""
`source`	number	0	required
`email`	string	""	required
`totalPrice`	number	0	required
`currency`	options	"eur"	required; `eur`, `usd`, `gbp`, `chf`, `cny`, `,aed`,`afn`, ... (171 total)
`connectionid`	number	0	required
`customerid`	number	0	required
`externalCreatedDate`	dateTime	""	required
`abandonedDate`	dateTime	""
`orderProducts`	collection	{}	keys: `name`, `price`, `quantity`, `externalid`, `category`, `sku`, ...
`additionalFields`	collection	{}	keys: `shippingAmount`, `taxAmount`, `discountAmount`, `orderUrl`, `externalUpdatedDate`, `shippingMethod`, ...

`delete`¶

Parameter	Type	Default	Details
`orderId`	number	0

`get`¶

Parameter	Type	Default	Details
`orderId`	number	0

`getAll`¶

Parameter	Type	Default
`returnAll`	boolean	false
`limit`	number	100
`simple`	boolean	true

`update`¶

Parameter	Type	Default	Details
`orderId`	number	0
`updateFields`	collection	{}	keys: `externalid`, `externalcheckoutid`, `source`, `email`, `totalPrice`, `currency`, ...

Resource: `ecommerceOrderProducts`¶

`getAll`¶

Parameter	Type	Default
`returnAll`	boolean	false
`limit`	number	100
`simple`	boolean	true

`getByProductId`¶

Parameter	Type	Default	Details
`procuctId`	number	0

`getByOrderId`¶

Parameter	Type	Default	Details
`orderId`	number	0

Resource: `list`¶

`getAll`¶

Parameter	Type	Default
`returnAll`	boolean	false
`limit`	number	100
`simple`	boolean	true

Resource: `tag`¶

`create`¶

Parameter	Type	Default	Details
`tagType`	options	"contact"	required; `contact`, `template`
`name`	string	""	required
`additionalFields`	collection	{}	keys: `description`

`delete`¶

Parameter	Type	Default	Details
`tagId`	number	0	required

`get`¶

Parameter	Type	Default	Details
`tagId`	number	0	required

`getAll`¶

Parameter	Type	Default
`returnAll`	boolean	false
`limit`	number	100
`simple`	boolean	true

`update`¶

Parameter	Type	Default	Details
`tagId`	number	0	required
`updateFields`	collection	{}	keys: `tag`, `description`

Parameter Details¶

additionalFields children:

Parameter	Type	Default	Details
`description`	string	""

updateFields children:

Parameter	Type	Default	Details
`tag`	string	""
`description`	string	""

filters children:

Parameter	Type	Default	Details
`search`	string	""

orderProducts children:

Parameter	Type	Default
`name`	string	""
`price`	number	0
`quantity`	number	0
`externalid`	string	""
`category`	string	""
`sku`	string	""
`description`	string	""
`imageUrl`	string	""
`productUrl`	string	""

Example¶

NODE "activeCampaign" @active AS "Active Campaign" {
  resource: "account",
  operation: "get",
  name: {{ $json.name }},
  tagId: 0,
  contactId: 0
}

Active Campaign¶

Credentials¶

Operations¶

Resource: account¶

create¶

delete¶

get¶

getAll¶

update¶

Resource: accountContact¶

create¶

delete¶

update¶

Resource: connection¶

create¶

delete¶

get¶

getAll¶

update¶

Resource: contact¶

create¶

delete¶

get¶

getAll¶

update¶

Resource: contactList¶

add¶

remove¶

Resource: contactTag¶

add¶

remove¶

Resource: deal¶

create¶

createNote¶

delete¶

get¶

getAll¶

update¶

updateNote¶

Resource: ecommerceCustomer¶

create¶

delete¶

get¶

getAll¶

update¶

Resource: ecommerceOrder¶

create¶

delete¶

get¶

getAll¶

update¶

Resource: ecommerceOrderProducts¶

getAll¶

getByProductId¶

getByOrderId¶

Resource: list¶

getAll¶

Resource: tag¶

create¶

delete¶

get¶

getAll¶

update¶

Parameter Details¶

Example¶

Resource: `account`¶

`create`¶

`delete`¶

`get`¶

`getAll`¶

`update`¶

Resource: `accountContact`¶

`create`¶

`delete`¶

`update`¶

Resource: `connection`¶

`create`¶

`delete`¶

`get`¶

`getAll`¶

`update`¶

Resource: `contact`¶

`create`¶

`delete`¶

`get`¶

`getAll`¶

`update`¶

Resource: `contactList`¶

`add`¶

`remove`¶

Resource: `contactTag`¶

`add`¶

`remove`¶

Resource: `deal`¶

`create`¶

`createNote`¶

`delete`¶

`get`¶

`getAll`¶

`update`¶

`updateNote`¶

Resource: `ecommerceCustomer`¶

`create`¶

`delete`¶

`get`¶

`getAll`¶

`update`¶

Resource: `ecommerceOrder`¶

`create`¶

`delete`¶

`get`¶

`getAll`¶

`update`¶

Resource: `ecommerceOrderProducts`¶

`getAll`¶

`getByProductId`¶

`getByOrderId`¶

Resource: `list`¶

`getAll`¶

Resource: `tag`¶

`create`¶

`delete`¶

`get`¶

`getAll`¶

`update`¶