Salesforce¶

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

Credentials¶

salesforceOAuth2Api (alias: @salesforce) / salesforceJwtApi (alias: @salesforce)

CREDENTIAL @salesforce = salesforceOAuth2Api "My Salesforce"

Operations¶

Resource: `account`¶

`addNote`¶

Parameter	Type	Default	Details
`accountId`	string	""	required
`title`	string	""	required
`options`	collection	{}	keys: `body`, `isPrivate`, `ownerId`

`create`¶

Parameter	Type	Default	Details
`name`	string	""	required
`additionalFields`	collection	{}	keys: `accountNumber`, `annualRevenue`, `accountSource`, `billingCity`, `billingCountry`, `billingPostalCode`, ...

`upsert`¶

Parameter	Type	Default	Details
`externalId`	options	""	required
`externalIdValue`	string	""	required
`name`	string	""	required
`additionalFields`	collection	{}	keys: `accountNumber`, `annualRevenue`, `accountSource`, `billingCity`, `billingCountry`, `billingPostalCode`, ...

`delete`¶

Parameter	Type	Default	Details
`accountId`	string	""	required

`get`¶

Parameter	Type	Default	Details
`accountId`	string	""	required

`getAll`¶

Parameter	Type	Default	Details
`returnAll`	boolean	false
`limit`	number	50
`options`	collection	{}	keys: `fields`, `conditionsUi`

`getSummary`¶

No additional parameters.

`update`¶

Parameter	Type	Default	Details
`accountId`	string	""	required
`updateFields`	collection	{}	keys: `accountNumber`, `accountSource`, `annualRevenue`, `billingCity`, `billingCountry`, `billingPostalCode`, ...

Resource: `attachment`¶

`create`¶

Parameter	Type	Default	Details
`parentId`	string	""	required
`name`	string	""	required
`binaryPropertyName`	string	"data"	required
`additionalFields`	collection	{}	keys: `description`, `isPrivate`, `owner`

`delete`¶

Parameter	Type	Default	Details
`attachmentId`	string	""	required

`get`¶

Parameter	Type	Default	Details
`attachmentId`	string	""	required

`getAll`¶

Parameter	Type	Default	Details
`returnAll`	boolean	false
`limit`	number	50
`options`	collection	{}	keys: `conditionsUi`, `fields`

`getSummary`¶

No additional parameters.

`update`¶

Parameter	Type	Default	Details
`attachmentId`	string	""	required
`updateFields`	collection	{}	keys: `binaryPropertyName`, `description`, `isPrivate`, `name`, `owner`

Resource: `case`¶

`addComment`¶

Parameter	Type	Default	Details
`caseId`	string	""	required
`options`	collection	{}	keys: `commentBody`, `isPublished`

`create`¶

Parameter	Type	Default	Details
`type`	options	""	required
`additionalFields`	collection	{}	keys: `accountId`, `contactId`, `customFieldsUi`, `description`, `isEscalated`, `origin`, ...

`delete`¶

Parameter	Type	Default	Details
`caseId`	string	""	required

`get`¶

Parameter	Type	Default	Details
`caseId`	string	""	required

`getAll`¶

Parameter	Type	Default	Details
`returnAll`	boolean	false
`limit`	number	50
`options`	collection	{}	keys: `conditionsUi`, `fields`

`getSummary`¶

No additional parameters.

`update`¶

Parameter	Type	Default	Details
`caseId`	string	""	required
`updateFields`	collection	{}	keys: `accountId`, `contactId`, `customFieldsUi`, `description`, `isEscalated`, `origin`, ...

Resource: `contact`¶

`addToCampaign`¶

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

`addNote`¶

Parameter	Type	Default	Details
`contactId`	string	""	required
`title`	string	""	required
`options`	collection	{}	keys: `body`, `isPrivate`, `owner`

`create`¶

Parameter	Type	Default	Details
`lastname`	string	""	required
`additionalFields`	collection	{}	keys: `acconuntId`, `assistantName`, `Assistant Phone`, `birthdate`, `customFieldsUi`, `department`, ...

`upsert`¶

Parameter	Type	Default	Details
`externalId`	options	""	required
`externalIdValue`	string	""	required
`lastname`	string	""	required
`additionalFields`	collection	{}	keys: `acconuntId`, `assistantName`, `Assistant Phone`, `birthdate`, `customFieldsUi`, `department`, ...

`delete`¶

Parameter	Type	Default	Details
`contactId`	string	""	required

`get`¶

Parameter	Type	Default	Details
`contactId`	string	""	required

`getAll`¶

Parameter	Type	Default	Details
`returnAll`	boolean	false
`limit`	number	50
`options`	collection	{}	keys: `conditionsUi`, `fields`

`getSummary`¶

No additional parameters.

`update`¶

Parameter	Type	Default	Details
`contactId`	string	""	required
`updateFields`	collection	{}	keys: `acconuntId`, `assistantName`, `Assistant Phone`, `birthdate`, `customFieldsUi`, `department`, ...

Resource: `customObject`¶

`create`¶

Parameter	Type	Default	Details
`customObject`	options	""	required
`customFieldsUi`	fixedCollection	{}	groups: `customFieldsValues`
`additionalFields`	collection	{}	keys: `recordTypeId`

`upsert`¶

Parameter	Type	Default	Details
`customObject`	options	""	required
`externalId`	options	""	required
`externalIdValue`	string	""	required
`customFieldsUi`	fixedCollection	{}	groups: `customFieldsValues`
`additionalFields`	collection	{}	keys: `recordTypeId`

`delete`¶

Parameter	Type	Default	Details
`customObject`	options	""	required
`recordId`	string	""	required

`get`¶

Parameter	Type	Default	Details
`customObject`	options	""	required
`recordId`	string	""	required

`getAll`¶

Parameter	Type	Default	Details
`customObject`	options	""	required
`returnAll`	boolean	false
`limit`	number	50
`options`	collection	{}	keys: `conditionsUi`, `fields`

`update`¶

Parameter	Type	Default	Details
`customObject`	options	""	required
`recordId`	string	""	required
`customFieldsUi`	fixedCollection	{}	groups: `customFieldsValues`
`updateFields`	collection	{}	keys: `recordTypeId`

Resource: `document`¶

`upload`¶

Parameter	Type	Default	Details
`title`	string	""	required
`binaryPropertyName`	string	"data"	required
`additionalFields`	collection	{}	keys: `fileExtension`, `linkToObjectId`, `ownerId`

Resource: `flow`¶

`getAll`¶

Parameter	Type	Default	Details
`returnAll`	boolean	false
`limit`	number	50

`invoke`¶

Parameter	Type	Default	Details
`apiName`	string	""	required
`jsonParameters`	boolean	false
`variablesJson`	json	""
`variablesUi`	fixedCollection	{}	groups: `variablesValues`

Resource: `lead`¶

`addToCampaign`¶

Parameter	Type	Default	Details
`leadId`	string	""	required
`campaignId`	options	""	required
`options`	collection	{}	keys: `status`

`addNote`¶

Parameter	Type	Default	Details
`leadId`	string	""	required
`title`	string	""	required
`options`	collection	{}	keys: `body`, `isPrivate`, `owner`

`create`¶

Parameter	Type	Default	Details
`company`	string	""	required
`lastname`	string	""	required
`additionalFields`	collection	{}	keys: `annualRevenue`, `city`, `country`, `customFieldsUi`, `description`, `email`, ...

`upsert`¶

Parameter	Type	Default	Details
`externalId`	options	""	required
`externalIdValue`	string	""	required
`company`	string	""	required
`lastname`	string	""	required
`additionalFields`	collection	{}	keys: `annualRevenue`, `city`, `country`, `customFieldsUi`, `description`, `email`, ...

`delete`¶

Parameter	Type	Default	Details
`leadId`	string	""	required

`get`¶

Parameter	Type	Default	Details
`leadId`	string	""	required

`getAll`¶

Parameter	Type	Default	Details
`returnAll`	boolean	false
`limit`	number	50
`options`	collection	{}	keys: `conditionsUi`, `fields`

`getSummary`¶

No additional parameters.

`update`¶

Parameter	Type	Default	Details
`leadId`	string	""	required
`updateFields`	collection	{}	keys: `annualRevenue`, `city`, `company`, `country`, `customFieldsUi`, `description`, ...

Resource: `opportunity`¶

`addNote`¶

Parameter	Type	Default	Details
`opportunityId`	string	""	required
`title`	string	""	required
`options`	collection	{}	keys: `body`, `isPrivate`, `owner`

`create`¶

Parameter	Type	Default	Details
`name`	string	""	required
`closeDate`	dateTime	""	required
`stageName`	options	""	required
`additionalFields`	collection	{}	keys: `accountId`, `amount`, `campaignId`, `customFieldsUi`, `description`, `forecastCategoryName`, ...

`upsert`¶

Parameter	Type	Default	Details
`externalId`	options	""	required
`externalIdValue`	string	""	required
`name`	string	""	required
`closeDate`	dateTime	""	required
`stageName`	options	""	required
`additionalFields`	collection	{}	keys: `accountId`, `amount`, `campaignId`, `customFieldsUi`, `description`, `forecastCategoryName`, ...

`delete`¶

Parameter	Type	Default	Details
`opportunityId`	string	""	required

`get`¶

Parameter	Type	Default	Details
`opportunityId`	string	""	required

`getAll`¶

Parameter	Type	Default	Details
`returnAll`	boolean	false
`limit`	number	50
`options`	collection	{}	keys: `conditionsUi`, `fields`

`getSummary`¶

No additional parameters.

`update`¶

Parameter	Type	Default	Details
`opportunityId`	string	""	required
`updateFields`	collection	{}	keys: `accountId`, `amount`, `campaignId`, `closeDate`, `customFieldsUi`, `description`, ...

Resource: `search`¶

`query`¶

Parameter	Type	Default	Details
`query`	string	""	required

Resource: `task`¶

`create`¶

Parameter	Type	Default	Details
`status`	options	""	required
`additionalFields`	collection	{}	keys: `activityDate`, `callDisposition`, `callDurationInSeconds`, `callObject`, `callType`, `customFieldsUi`, ...

`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
`options`	collection	{}	keys: `conditionsUi`, `fields`

`getSummary`¶

No additional parameters.

`update`¶

Parameter	Type	Default	Details
`taskId`	string	""	required
`updateFields`	collection	{}	keys: `activityDate`, `callDisposition`, `callDurationInSeconds`, `callObject`, `callType`, `customFieldsUi`, ...

Resource: `user`¶

`get`¶

Parameter	Type	Default	Details
`userId`	string	""	required

`getAll`¶

Parameter	Type	Default	Details
`returnAll`	boolean	false
`limit`	number	50
`options`	collection	{}	keys: `conditionsUi`, `fields`

Common Parameters¶

Parameter	Type	Default	Details
`authentication`	options	"oAuth2"	`oAuth2`, `jwt`

Parameter Details¶

additionalFields children:

Parameter	Type	Default	Details
`annualRevenue`	number	""
`city`	string	""
`country`	string	""
`customFieldsUi`	fixedCollection	{}	groups: `customFieldsValues`
`description`	string	""
`email`	string	""
`fax`	number	""
`firstname`	string	""
`hasOptedOutOfEmail`	boolean	false
`hasOptedOutOfFax`	boolean	false
`industry`	string	""
`IsUnreadByOwner`	boolean	false
`jigsaw`	string	""
`leadSource`	options	""
`mobilePhone`	string	""
`numberOfEmployees`	number	""
`owner`	options	""
`phone`	string	""
`postalCode`	string	""
`recordTypeId`	options	""
`rating`	string	""
`salutation`	string	""
`state`	string	""
`status`	options	""
`street`	string	""
`title`	string	""
`website`	string	""

updateFields children:

Parameter	Type	Default	Details
`annualRevenue`	number	""
`city`	string	""
`company`	string	""
`country`	string	""
`customFieldsUi`	fixedCollection	{}	groups: `customFieldsValues`
`description`	string	""
`email`	string	""
`fax`	number	""
`firstname`	string	""
`hasOptedOutOfEmail`	boolean	false
`HasOptedOutOfFax`	boolean	false
`industry`	string	""
`IsUnreadByOwner`	boolean	false
`jigsaw`	string	""
`lastname`	string	""
`leadSource`	options	""
`mobilePhone`	string	""
`numberOfEmployees`	number	""
`owner`	options	""
`postalCode`	string	""
`phone`	string	""
`recordTypeId`	options	""
`rating`	string	""
`salutation`	string	""
`state`	string	""
`status`	options	""
`street`	string	""
`title`	string	""
`website`	string	""

options children:

Parameter	Type	Default	Details
`conditionsUi`	fixedCollection	{}	groups: `conditionValues`
`fields`	string	""

customFieldsUi children:

customFieldsValues group:

Parameter	Type	Default	Details
`fieldId`	options	""
`value`	string	""

variablesUi children:

variablesValues group:

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

Example¶

NODE "salesforce" @salesforce AS "Salesforce" {
  resource: "account",
  operation: "get",
  externalIdValue: {{ $json.externalIdValue }},
  company: {{ $json.company }},
  lastname: {{ $json.lastname }}
}

Salesforce¶

Credentials¶

Operations¶

Resource: account¶

addNote¶

create¶

upsert¶

delete¶

get¶

getAll¶

getSummary¶

update¶

Resource: attachment¶

create¶

delete¶

get¶

getAll¶

getSummary¶

update¶

Resource: case¶

addComment¶

create¶

delete¶

get¶

getAll¶

getSummary¶

update¶

Resource: contact¶

addToCampaign¶

addNote¶

create¶

upsert¶

delete¶

get¶

getAll¶

getSummary¶

update¶

Resource: customObject¶

create¶

upsert¶

delete¶

get¶

getAll¶

update¶

Resource: document¶

upload¶

Resource: flow¶

getAll¶

invoke¶

Resource: lead¶

addToCampaign¶

addNote¶

create¶

upsert¶

delete¶

get¶

getAll¶

getSummary¶

update¶

Resource: opportunity¶

addNote¶

create¶

upsert¶

delete¶

get¶

getAll¶

getSummary¶

update¶

Resource: search¶

query¶

Resource: task¶

create¶

delete¶

get¶

getAll¶

getSummary¶

update¶

Resource: user¶

get¶

getAll¶

Resource: `account`¶

`addNote`¶

`create`¶

`upsert`¶

`delete`¶

`get`¶

`getAll`¶

`getSummary`¶

`update`¶

Resource: `attachment`¶

`create`¶

`delete`¶

`get`¶

`getAll`¶

`getSummary`¶

`update`¶

Resource: `case`¶

`addComment`¶

`create`¶

`delete`¶

`get`¶

`getAll`¶

`getSummary`¶

`update`¶

Resource: `contact`¶

`addToCampaign`¶

`addNote`¶

`create`¶

`upsert`¶

`delete`¶

`get`¶

`getAll`¶

`getSummary`¶

`update`¶

Resource: `customObject`¶

`create`¶

`upsert`¶

`delete`¶

`get`¶

`getAll`¶

`update`¶

Resource: `document`¶

`upload`¶

Resource: `flow`¶

`getAll`¶

`invoke`¶

Resource: `lead`¶

`addToCampaign`¶

`addNote`¶

`create`¶

`upsert`¶

`delete`¶

`get`¶

`getAll`¶

`getSummary`¶

`update`¶

Resource: `opportunity`¶

`addNote`¶

`create`¶

`upsert`¶

`delete`¶

`get`¶

`getAll`¶

`getSummary`¶

`update`¶

Resource: `search`¶

`query`¶

Resource: `task`¶

`create`¶

`delete`¶

`get`¶

`getAll`¶

`getSummary`¶

`update`¶

Resource: `user`¶

`get`¶

`getAll`¶