Keap¶

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

Credentials¶

keapOAuth2Api (alias: @keap)

CREDENTIAL @keap = keapOAuth2Api "My Keap"

Operations¶

Resource: `company`¶

`create`¶

Parameter	Type	Default	Details
`companyName`	string	""	required
`additionalFields`	collection	{}	keys: `emailAddress`, `notes`, `optInReason`, `website`
`addressesUi`	fixedCollection	{}	groups: `addressesValues`
`faxesUi`	fixedCollection	{}	groups: `faxesValues`
`phonesUi`	fixedCollection	{}	groups: `phonesValues`

`getAll`¶

Parameter	Type	Default	Details
`returnAll`	boolean	false
`limit`	number	100
`options`	collection	{}	keys: `companyName`, `order`, `orderDirection`, `fields`

Resource: `contact`¶

`upsert`¶

Parameter	Type	Default	Details
`duplicateOption`	options	"email"	required; `email`, `emailAndName`
`additionalFields`	collection	{}	keys: `anniversary`, `companyId`, `contactType`, `familyName`, `givenName`, `ipAddress`, ...
`addressesUi`	fixedCollection	{}	groups: `addressesValues`
`emailsUi`	fixedCollection	{}	groups: `emailsValues`
`faxesUi`	fixedCollection	{}	groups: `faxesValues`
`phonesUi`	fixedCollection	{}	groups: `phonesValues`
`socialAccountsUi`	fixedCollection	{}	groups: `socialAccountsValues`

`delete`¶

Parameter	Type	Default	Details
`contactId`	string	""	required

`get`¶

Parameter	Type	Default	Details
`contactId`	string	""	required
`options`	collection	{}	keys: `fields`

`getAll`¶

Parameter	Type	Default	Details
`returnAll`	boolean	false
`limit`	number	100
`options`	collection	{}	keys: `email`, `givenName`, `familyName`, `order`, `orderDirection`, `since`, ...

Resource: `contactNote`¶

`create`¶

Parameter	Type	Default	Details
`userId`	options	""
`contactId`	string	""
`additionalFields`	collection	{}	keys: `body`, `title`, `type`

`delete`¶

Parameter	Type	Default	Details
`noteId`	string	""	required

`get`¶

Parameter	Type	Default	Details
`noteId`	string	""	required

`getAll`¶

Parameter	Type	Default	Details
`returnAll`	boolean	false
`limit`	number	100
`filters`	collection	{}	keys: `contactId`, `userId`

`update`¶

Parameter	Type	Default	Details
`noteId`	string	""	required
`additionalFields`	collection	{}	keys: `body`, `contactId`, `title`, `type`, `userId`

Resource: `contactTag`¶

`create`¶

Parameter	Type	Default	Details
`contactId`	string	""	required
`tagIds`	multiOptions	[]	required

`delete`¶

Parameter	Type	Default	Details
`contactId`	string	""	required
`tagIds`	string	"Tag IDs, multiple IDs can be set sepa..."	required

`getAll`¶

Parameter	Type	Default	Details
`contactId`	string	""	required
`returnAll`	boolean	false
`limit`	number	100

Resource: `ecommerceOrder`¶

`create`¶

Parameter	Type	Default	Details
`contactId`	string	""	required
`orderDate`	dateTime	""	required
`orderTitle`	string	""	required
`orderType`	options	""	required; `offline`, `online`
`additionalFields`	collection	{}	keys: `leadAffiliateId`, `promoCodes`, `salesAffiliateId`
`addressUi`	fixedCollection	{}	groups: `addressValues`
`orderItemsUi`	fixedCollection	{}	groups: `orderItemsValues`

`get`¶

Parameter	Type	Default	Details
`orderId`	string	""	required

`delete`¶

Parameter	Type	Default	Details
`orderId`	string	""	required

`getAll`¶

Parameter	Type	Default	Details
`returnAll`	boolean	false
`limit`	number	100
`options`	collection	{}	keys: `since`, `until`, `paid`, `order`, `contactId`, `productId`

Resource: `ecommerceProduct`¶

`create`¶

Parameter	Type	Default	Details
`productName`	string	""	required
`additionalFields`	collection	{}	keys: `active`, `productDesc`, `productPrice`, `productShortDesc`, `sku`, `subscriptionOnly`

`delete`¶

Parameter	Type	Default	Details
`productId`	string	""	required

`get`¶

Parameter	Type	Default	Details
`productId`	string	""	required

`getAll`¶

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

Resource: `email`¶

`createRecord`¶

Parameter	Type	Default	Details
`sentToAddress`	string	""	required
`sentFromAddress`	string	""	required
`additionalFields`	collection	{}	keys: `clickedDate`, `contactId`, `headers`, `htmlContent`, `openedDate`, `originalProvider`, ...

`getAll`¶

Parameter	Type	Default	Details
`returnAll`	boolean	false
`limit`	number	100
`filters`	collection	{}	keys: `contactId`, `email`, `sinceSentDate`, `untilSentDate`

`send`¶

Parameter	Type	Default	Details
`userId`	options	""	required
`contactIds`	string	""
`subject`	string	""
`additionalFields`	collection	{}	keys: `addressField`, `htmlContent`, `plainContent`
`attachmentsUi`	fixedCollection	{}	groups: `attachmentsValues`, `attachmentsBinary`

Resource: `file`¶

`delete`¶

Parameter	Type	Default	Details
`fileId`	string	""	required

`getAll`¶

Parameter	Type	Default	Details
`returnAll`	boolean	false
`limit`	number	100
`filters`	collection	{}	keys: `contactId`, `name`, `permission`, `type`, `viewable`

`upload`¶

Parameter	Type	Default	Details
`binaryData`	boolean	false
`binaryPropertyName`	string	"data"	required
`fileAssociation`	options	""	required; `company`, `contact`, `user`
`contactId`	string	""	required
`fileName`	string	""	required
`fileData`	string	""	required
`isPublic`	boolean	false

Parameter Details¶

additionalFields children:

Parameter	Type	Default
`emailAddress`	string	""
`notes`	string	""
`optInReason`	string	""
`website`	string	""

addressesUi children:

addressesValues group:

Parameter	Type	Default
`countryCode`	string	""
`line1`	string	""
`line2`	string	""
`locality`	string	""
`postalCode`	string	""
`region`	string	""
`zipCode`	string	""
`zipFour`	string	""

faxesUi children:

faxesValues group:

Parameter	Type	Default	Details
`type`	string	""
`number`	string	""

phonesUi children:

phonesValues group:

Parameter	Type	Default	Details
`type`	string	""
`number`	string	""

options children:

Parameter	Type	Default	Details
`companyName`	string	""
`order`	options	""	`datecreated`, `id`, `name`
`orderDirection`	options	""	`ascending`, `descending`
`fields`	string	""

emailsUi children:

emailsValues group:

Parameter	Type	Default	Details
`field`	options	""	`EMAIL1`, `EMAIL2`, `EMAIL3`
`email`	string	""

socialAccountsUi children:

socialAccountsValues group:

Parameter	Type	Default	Details
`type`	options	""	`Facebook`, `Twitter`, `LinkedIn`
`name`	string	""

filters children:

Parameter	Type	Default	Details
`contactId`	number	0
`userId`	options	""

addressUi children:

addressValues group:

Parameter	Type	Default
`company`	string	""
`countryCode`	options	""
`firstName`	string	""
`middleName`	string	""
`lastName`	string	""
`line1`	string	""
`line2`	string	""
`locality`	string	""
`region`	string	""
`zipCode`	string	""
`zipFour`	string	""
`phone`	string	""

orderItemsUi children:

orderItemsValues group:

Parameter	Type	Default
`description`	string	""
`price`	number	0
`product ID`	number	0
`quantity`	number	1

attachmentsUi children:

attachmentsValues group:

Parameter	Type	Default	Details
`fileData`	string	""
`fileName`	string	""

attachmentsBinary group:

Parameter	Type	Default	Details
`property`	string	""

Example¶

NODE "keap" @keap AS "Keap" {
  resource: "company",
  operation: "get",
  companyName: {{ $json.companyName }},
  contactId: {{ $json.contactId }},
  noteId: {{ $json.noteId }}
}

Keap¶

Credentials¶

Operations¶

Resource: company¶

create¶

getAll¶

Resource: contact¶

upsert¶

delete¶

get¶

getAll¶

Resource: contactNote¶

create¶

delete¶

get¶

getAll¶

update¶

Resource: contactTag¶

create¶

delete¶

getAll¶

Resource: ecommerceOrder¶

create¶

get¶

delete¶

getAll¶

Resource: ecommerceProduct¶

create¶

delete¶

get¶

getAll¶

Resource: email¶

createRecord¶

getAll¶

send¶

Resource: file¶

delete¶

getAll¶

upload¶

Parameter Details¶

Example¶

Resource: `company`¶

`create`¶

`getAll`¶

Resource: `contact`¶

`upsert`¶

`delete`¶

`get`¶

`getAll`¶

Resource: `contactNote`¶

`create`¶

`delete`¶

`get`¶

`getAll`¶

`update`¶

Resource: `contactTag`¶

`create`¶

`delete`¶

`getAll`¶

Resource: `ecommerceOrder`¶

`create`¶

`get`¶

`delete`¶

`getAll`¶

Resource: `ecommerceProduct`¶

`create`¶

`delete`¶

`get`¶

`getAll`¶

Resource: `email`¶

`createRecord`¶

`getAll`¶

`send`¶

Resource: `file`¶

`delete`¶

`getAll`¶

`upload`¶