Freshworks Crm

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

Credentials

freshworksCrmApi (alias: @freshworks)

CREDENTIAL @freshworks = freshworksCrmApi "My Freshworks Crm"

Operations

Resource: account

create

Parameter	Type	Default	Details
name	string	""	required
additionalFields	collection	{}	keys: address, annual_revenue, business_type_id, city, country, facebook, ...

delete

Parameter	Type	Default	Details
accountId	string	""	required

get

Parameter	Type	Default	Details
accountId	string	""	required

getAll

Parameter	Type	Default	Details
view	options	""	required
returnAll	boolean	false
limit	number	50

update

Parameter	Type	Default	Details
accountId	string	""	required
updateFields	collection	{}	keys: address, annual_revenue, business_type_id, city, country, facebook, ...

Resource: appointment

create

Parameter	Type	Default	Details
title	string	""	required
fromDate	dateTime	""	required
endDate	dateTime	""	required
attendees	fixedCollection	{}	groups: attendee
additionalFields	collection	{}	keys: creater_id, is_allday, latitude, location, longitude, outcome_id, ...

delete

Parameter	Type	Default	Details
appointmentId	string	""	required

get

Parameter	Type	Default	Details
appointmentId	string	""	required

getAll

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

update

Parameter	Type	Default	Details
appointmentId	string	""	required
updateFields	collection	{}	keys: attendees, creater_id, endDate, is_allday, latitude, location, ...

Resource: contact

create

Parameter	Type	Default	Details
firstName	string	""	required
lastName	string	""	required
emails	string	""	required
additionalFields	collection	{}	keys: address, campaign_id, city, contact_status_id, country, external_id, ...

delete

Parameter	Type	Default	Details
contactId	string	""	required

get

Parameter	Type	Default	Details
contactId	string	""	required

getAll

Parameter	Type	Default	Details
view	options	""
returnAll	boolean	false
limit	number	50

update

Parameter	Type	Default	Details
contactId	string	""	required
updateFields	collection	{}	keys: address, campaign_id, city, contact_status_id, country, external_id, ...

Resource: deal

create

Parameter	Type	Default	Details
amount	number	0	required
name	string	""	required
additionalFields	collection	{}	keys: base_currency_amount, campaign_id, currency_id, deal_payment_status_id, deal_pipeline_id, deal_product_id, ...

delete

Parameter	Type	Default	Details
dealId	string	""	required

get

Parameter	Type	Default	Details
dealId	string	""	required

getAll

Parameter	Type	Default	Details
view	options	""
returnAll	boolean	false
limit	number	50

update

Parameter	Type	Default	Details
dealId	string	""	required
updateFields	collection	{}	keys: amount, base_currency_amount, campaign_id, currency_id, deal_payment_status_id, deal_pipeline_id, ...

Resource: note

create

Parameter	Type	Default	Details
description	string	""	required
targetableType	options	"Contact"	required; Contact, Deal, SalesAccount
targetable_id	string	""	required

delete

Parameter	Type	Default	Details
noteId	string	""	required

update

Parameter	Type	Default	Details
noteId	string	""	required
updateFields	collection	{}	keys: description, targetable_id, targetable_type

Resource: salesActivity

get

Parameter	Type	Default	Details
salesActivityId	string	""	required

getAll

Parameter	Type	Default	Details
returnAll	boolean	false
limit	number	50

Resource: search

query

Parameter	Type	Default	Details
query	string	""	required
entities	multiOptions	[]	required; multi: contact, deal, sales_account, user
returnAll	boolean	false
limit	number	25

lookup

Parameter	Type	Default	Details
searchField	options	""	required; email, name, customField
customFieldName	string	""	required
customFieldValue	string	""	required
fieldValue	string	""	required
options	collection	{}	keys: entities

Resource: task

create

Parameter	Type	Default	Details
title	string	""	required
dueDate	dateTime	""	required
ownerId	options	""	required
targetableType	options	"Contact"	required; Contact, Deal, SalesAccount
targetable_id	string	""	required
additionalFields	collection	{}	keys: creater_id, outcome_id, task_type_id

delete

Parameter	Type	Default	Details
taskId	string	""	required

get

Parameter	Type	Default	Details
taskId	string	""	required

getAll

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

update

Parameter	Type	Default	Details
taskId	string	""	required
updateFields	collection	{}	keys: creater_id, dueDate, outcome_id, owner_id, targetable_id, targetable_type, ...

Parameter Details

additionalFields children:

Parameter	Type	Default	Details
address	string	""
annual_revenue	number	0
business_type_id	options	""
city	string	""
country	string	""
facebook	string	""
industry_type_id	options	""
linkedin	string	""
number_of_employees	number	0
owner_id	options	""
parent_sales_account_id	string	""
phone	string	""
state	string	""
territory_id	options	""
twitter	string	""
website	string	""
zipcode	string	""

updateFields children:

Parameter	Type	Default	Details
address	string	""
annual_revenue	number	0
business_type_id	options	""
city	string	""
country	string	""
facebook	string	""
industry_type_id	options	""
linkedin	string	""
name	string	""
number_of_employees	number	0
owner_id	options	""
parent_sales_account_id	string	""
phone	string	""
state	string	""
territory_id	options	""
twitter	string	""
website	string	""
zipcode	string	""

attendees children:

attendee group:

Parameter	Type	Default	Details
type	options	"contact"	contact, user
userId	options	""
contactId	string	""

filters children:

Parameter	Type	Default	Details
include	options	"creater"	appointment_attendees, creater, targetable
filter	options	"upcoming"	past, upcoming

options children:

Parameter	Type	Default	Details
entities	multiOptions	[]	multi: contact, deal, sales_account

Example

NODE "freshworksCrm" @freshworks AS "Freshworks Crm" {
  resource: "account",
  operation: "get",
  name: {{ $json.name }},
  accountId: {{ $json.accountId }},
  title: {{ $json.title }}
}