Intercom

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

Credentials

intercomApi (alias: @intercom)

CREDENTIAL @intercom = intercomApi "My Intercom"

Operations

Resource: company

create

Parameter	Type	Default	Details
companyId	string	""
jsonParameters	boolean	false
additionalFields	collection	{}	keys: industry, monthlySpend, name, plan, size, website
customAttributesJson	json	""
customAttributesUi	fixedCollection	{}	groups: customAttributesValues

get

Parameter	Type	Default	Details
selectBy	options	""	companyId, id, name
value	string	""	required

getAll

Parameter	Type	Default	Details
returnAll	boolean	false
limit	number	50
filters	collection	{}	keys: segment_id, tag_id

update

Parameter	Type	Default	Details
companyId	string	""
jsonParameters	boolean	false
additionalFields	collection	{}	keys: industry, monthlySpend, name, plan, size, website
customAttributesJson	json	""
customAttributesUi	fixedCollection	{}	groups: customAttributesValues

users

Parameter	Type	Default	Details
listBy	options	""	id, companyId
value	string	""	required
returnAll	boolean	false
limit	number	50

Resource: lead

create

Parameter	Type	Default	Details
email	string	""	required
jsonParameters	boolean	false
additionalFields	collection	{}	keys: avatar, companies, email, name, phone, unsubscribedFromEmails, ...
customAttributesJson	json	""
customAttributesUi	fixedCollection	{}	groups: customAttributesValues

delete

Parameter	Type	Default	Details
deleteBy	options	""	id, userId
value	string	""	required

get

Parameter	Type	Default	Details
selectBy	options	""	email, id, userId, phone
value	string	""	required

getAll

Parameter	Type	Default	Details
returnAll	boolean	false
limit	number	50
filters	collection	{}	keys: email, phone

update

Parameter	Type	Default	Details
updateBy	options	"id"	userId, id
value	string	""	required
jsonParameters	boolean	false
additionalFields	collection	{}	keys: avatar, companies, email, name, phone, unsubscribedFromEmails, ...
customAttributesJson	json	""
customAttributesUi	fixedCollection	{}	groups: customAttributesValues

Resource: user

create

Parameter	Type	Default	Details
identifierType	options	""	userId, email
idValue	string	""	required
jsonParameters	boolean	false
additionalFields	collection	{}	keys: avatar, companies, email, name, phone, sessionCount, ...
customAttributesJson	json	""
customAttributesUi	fixedCollection	{}	groups: customAttributesValues

delete

Parameter	Type	Default	Details
id	string	""	required

get

Parameter	Type	Default	Details
selectBy	options	""	id, userId
value	string	""	required

getAll

Parameter	Type	Default	Details
returnAll	boolean	false
limit	number	50
filters	collection	{}	keys: company_id, email, segment_id, tag_id

update

Parameter	Type	Default	Details
updateBy	options	"id"	id, email, userId
value	string	""	required
jsonParameters	boolean	false
additionalFields	collection	{}	keys: avatar, companies, email, name, phone, sessionCount, ...
customAttributesJson	json	""
customAttributesUi	fixedCollection	{}	groups: customAttributesValues

Parameter Details

filters children:

Parameter	Type	Default	Details
company_id	string	""
email	string	""
segment_id	string	""
tag_id	string	""

additionalFields children:

Parameter	Type	Default	Details
avatar	string	""
companies	multiOptions	[]
email	string	""
name	string	""
phone	string	""
sessionCount	number	false
userId	string	""
unsubscribedFromEmails	boolean	false
updateLastRequestAt	boolean	false
utmCampaign	string	""
utmContent	string	""
utmMedium	string	""
utmSource	string	""
utmTerm	string	""

customAttributesUi children:

customAttributesValues group:

Parameter	Type	Default	Details
name	string	""
value	string	""

Example

NODE "intercom" @intercom AS "Intercom" {
  resource: "company",
  operation: "get",
  id: {{ $json.id }},
  value: {{ $json.value }},
  idValue: {{ $json.idValue }}
}