Salesforce

Interact with Salesforce

This node signs in with a credential: API Key. See Connect a credential.

Actions

Steps this node can perform. Add one from Add a step, then pick the action.

Find Records

Search for records in Salesforce using SOQL or field-based search

Settings

Field	Type	Required	Description
Object Type	Choice (loaded from your account)	Yes	The type of object to work with
Search Field	Choice (loaded from your account)		The field to search in
Search Value	Text		The value to search for
Search Operator	Choice		The operator to use for comparison (=, !=, LIKE, etc.) Options: Equals, Not Equals, Like, Not Like, In, Not In, Greater Than, Less Than, Greater Than or Equal, Less Than or Equal Default: =
Where Clause	Text		Custom SOQL WHERE clause (e.g., 'Email LIKE '%example.com'')
Fields	Choice (loaded from your account)		Comma-separated list of fields to return (leave empty for all fields)
Order By	Choice (loaded from your account)		Field to order results by
Order Direction	Choice		Direction to order results Options: Ascending, Descending Default: ASC
Limit	Number		Maximum number of records to return (default: 200) Default: 200
Offset	Number		Number of records to skip (for pagination) Default: 0

Output

Later steps use this data by picking this step in the $ picker. For example, records[0].attributes.type is $.<step ID>.output.records[0].attributes.type.

{
  "records": [
    {
      "attributes": {
        "type": "Account",
        "url": "string"
      },
      "Id": "string"
    }
  ],
  "totalSize": 0,
  "done": false
}

Example values show the shape of the data, not real values. See Using data from earlier steps.

Field descriptions

Field	Type	Description
records[]	List	List of found records
records[].attributes	Object	Record metadata from Salesforce
records[].attributes.type	Text	Object API name, e.g. Account
records[].attributes.url	Text	REST API path of the record
records[].Id	Text	ID of the record. Absent when fields leaves Id out
totalSize	Number	Total number of records found
done	Yes / No	Whether all records have been retrieved

Add Note to Account

Add a note to an account

Settings

Field	Type	Required	Description
Account ID	Text	Yes	The ID of the account to add the note to
Note Content	Text	Yes	The content of the note to add
Note Title	Text		The title of the note
Is Private	Yes / No		Whether the note is private

Output

Later steps use this data by picking this step in the $ picker. For example, id is $.<step ID>.output.id.

{
  "id": "string",
  "success": false,
  "errors": [
    {
      "statusCode": "REQUIRED_FIELD_MISSING",
      "message": "string",
      "fields": [
        "string"
      ]
    }
  ],
  "statusCode": 0
}

Example values show the shape of the data, not real values. See Using data from earlier steps.

Field descriptions

Field	Type	Description
id	Text	ID of the created record
success	Yes / No	True when Salesforce created the record
errors[]	List	Errors Salesforce reported. Empty on success: a failed create fails the node instead
errors[].statusCode	Text	Salesforce error code, e.g. REQUIRED_FIELD_MISSING
errors[].message	Text	Error message
errors[].fields[]	List	API names of the fields the error concerns
statusCode	Number	HTTP status code of the Salesforce response

Create Account

Create a new account

Settings

Field	Type	Required	Description
Account Name	Text	Yes	The name of the account
Account Number	Text		The account number
Account Site	Text		The account site
Type	Choice		The type of account Options: Prospect, Customer - Direct, Customer - Channel, Channel Partner / Reseller, Installation Partner, Technology Partner, Other
Industry	Choice		The industry of the account
Annual Revenue	Number		The annual revenue of the account
Rating	Choice		The rating of the account Options: Hot, Warm, Cold
Phone	Text		The phone number of the account
Fax	Text		The fax number of the account
Website	Text		The website of the account
Ticker Symbol	Text		The ticker symbol of the account
Ownership	Choice		The ownership of the account Options: Public, Private, Other
Employees	Number		The number of employees
SIC Code	Text		The SIC code of the account
Billing Country	Choice (loaded from your account)		The billing country
Billing Street	Text		The billing street address
Billing City	Text		The billing city
Billing State/Province	Choice (loaded from your account)		The billing state or province
Billing Zip/Postal Code	Text		The billing zip/postal code
Shipping Country	Choice (loaded from your account)		The shipping country
Shipping Street	Text		The shipping street address
Shipping City	Text		The shipping city
Shipping State/Province	Choice (loaded from your account)		The shipping state or province
Shipping Zip/Postal Code	Text		The shipping zip/postal code
Description	Text		The description of the account

Output

Later steps use this data by picking this step in the $ picker. For example, account is $.<step ID>.output.account.

{
  "account": {}
}

Example values show the shape of the data, not real values. See Using data from earlier steps.

Field descriptions

Field	Type	Description
account	Any
account.id	Text	ID of the written record
account.success	Yes / No	True when Salesforce accepted the write
account.data	Object	What the write returned or sent; the parent field's description says which

Update Account

Update an account. At least one account field must be provided to update.

Settings

Field	Type	Required	Description
Account ID	Text	Yes	The ID of the account to update
Account Name	Text		The name of the account
Parent Account	Text		The parent account
Account Number	Text		The account number
Account Site	Text		The account site
Type	Text		The type of account
Industry	Text		The industry of the account
Annual Revenue	Number		The annual revenue of the account
Rating	Text		The rating of the account
Phone	Text		The phone number of the account
Fax	Text		The fax number of the account
Website	Text		The website of the account
Ticker Symbol	Text		The ticker symbol of the account
Ownership	Text		The ownership of the account
Employees	Number		The number of employees
SIC Code	Text		The SIC code of the account
Billing Country	Choice (loaded from your account)		The billing country
Billing Street	Text		The billing street address
Billing City	Text		The billing city
Billing State/Province	Choice (loaded from your account)		The billing state or province
Billing Zip/Postal Code	Text		The billing zip/postal code
Shipping Country	Choice (loaded from your account)		The shipping country
Shipping Street	Text		The shipping street address
Shipping City	Text		The shipping city
Shipping State/Province	Choice (loaded from your account)		The shipping state or province
Shipping Zip/Postal Code	Text		The shipping zip/postal code
Description	Text		The description of the account

Output

Later steps use this data by picking this step in the $ picker. For example, account is $.<step ID>.output.account.

{
  "account": {}
}

Example values show the shape of the data, not real values. See Using data from earlier steps.

Field descriptions

Field	Type	Description
account	Any
account.id	Text	ID of the written record
account.success	Yes / No	True when Salesforce accepted the write
account.data	Object	What the write returned or sent; the parent field's description says which

Create Task

Create a task

Settings

Field	Type	Required	Description
Assignee	Choice (loaded from your account)	Yes	The user to assign the task to
Status	Choice	Yes	The status of the task Options: Not Started, In Progress, Completed, Waiting on someone else, Deferred
Subject	Text	Yes	The subject of the task
Name	Choice (loaded from your account)		The contact related to the task
Due Date	Text		Format YYYY-MM-DD eg. 2022-11-20.
Related To	Choice (loaded from your account)		Related to an Account
Priority	Choice	Yes	The priority of the task Options: High, Normal, Low
Comments	Text		Additional comments for the task

Output

Later steps use this data by picking this step in the $ picker. For example, task is $.<step ID>.output.task.

{
  "task": {}
}

Example values show the shape of the data, not real values. See Using data from earlier steps.

Field descriptions

Field	Type	Description
task	Any
task.id	Text	ID of the written record
task.success	Yes / No	True when Salesforce accepted the write
task.data	Object	What the write returned or sent; the parent field's description says which

Update Task

Update a task

Settings

Field	Type	Required	Description
Task ID	Text	Yes	The ID of the task to update
Owner ID	Choice (loaded from your account)		The user ID to assign the task to
Status	Choice		The status of the task Options: Not Started, In Progress, Completed, Waiting on someone else, Deferred
Subject	Text		The subject of the task
Name	Choice (loaded from your account)		The contact related to the task
Due Date	Text		Format YYYY-MM-DD eg. 2022-11-20.
Related To	Choice (loaded from your account)		Related to an Account
Priority	Choice		The priority of the task Options: High, Normal, Low

Output

Later steps use this data by picking this step in the $ picker. For example, task is $.<step ID>.output.task.

{
  "task": {}
}

Example values show the shape of the data, not real values. See Using data from earlier steps.

Field descriptions

Field	Type	Description
task	Any
task.id	Text	ID of the written record
task.success	Yes / No	True when Salesforce accepted the write
task.data	Object	What the write returned or sent; the parent field's description says which

Add Note to Contact

Add a note to a contact

Settings

Field	Type	Required	Description
Contact ID	Text	Yes	The ID of the contact to add the note to
Note Content	Text	Yes	The content of the note to add
Note Title	Text		The title of the note
Is Private	Yes / No		Whether the note is private

Output

Later steps use this data by picking this step in the $ picker. For example, id is $.<step ID>.output.id.

{
  "id": "string",
  "success": false,
  "errors": [
    {
      "statusCode": "REQUIRED_FIELD_MISSING",
      "message": "string",
      "fields": [
        "string"
      ]
    }
  ],
  "statusCode": 0
}

Example values show the shape of the data, not real values. See Using data from earlier steps.

Field descriptions

Field	Type	Description
id	Text	ID of the created record
success	Yes / No	True when Salesforce created the record
errors[]	List	Errors Salesforce reported. Empty on success: a failed create fails the node instead
errors[].statusCode	Text	Salesforce error code, e.g. REQUIRED_FIELD_MISSING
errors[].message	Text	Error message
errors[].fields[]	List	API names of the fields the error concerns
statusCode	Number	HTTP status code of the Salesforce response

Add Note to Opportunity

Add a note to an opportunity

Settings

Field	Type	Required	Description
Opportunity ID	Text	Yes	The ID of the opportunity to add the note to
Note Content	Text	Yes	The content of the note to add
Note Title	Text		The title of the note
Is Private	Yes / No		Whether the note is private

Output

Later steps use this data by picking this step in the $ picker. For example, id is $.<step ID>.output.id.

{
  "id": "string",
  "success": false,
  "errors": [
    {
      "statusCode": "REQUIRED_FIELD_MISSING",
      "message": "string",
      "fields": [
        "string"
      ]
    }
  ],
  "statusCode": 0
}

Example values show the shape of the data, not real values. See Using data from earlier steps.

Field descriptions

Field	Type	Description
id	Text	ID of the created record
success	Yes / No	True when Salesforce created the record
errors[]	List	Errors Salesforce reported. Empty on success: a failed create fails the node instead
errors[].statusCode	Text	Salesforce error code, e.g. REQUIRED_FIELD_MISSING
errors[].message	Text	Error message
errors[].fields[]	List	API names of the fields the error concerns
statusCode	Number	HTTP status code of the Salesforce response

Create Contact

Creates a new Salesforce contact

Settings

Field	Type	Required	Description
First Name	Text		The first name of the contact
Last Name	Text	Yes	The last name of the contact
Email	Text		The email of the contact
Phone	Text		The phone number of the contact
Account ID	Text		The ID of the account to associate with the contact
Title	Text		The job title of the contact
Department	Text		The department of the contact
Mailing Country	Choice (loaded from your account)		The country for mailing
Mailing Street	Text		The street address for mailing
Mailing City	Text		The city for mailing
Mailing State	Choice (loaded from your account)		The state/province for mailing
Mailing Postal Code	Text		The postal code for mailing

Output

Later steps use this data by picking this step in the $ picker. For example, id is $.<step ID>.output.id.

{
  "id": "string",
  "success": false,
  "errors": [
    {
      "statusCode": "REQUIRED_FIELD_MISSING",
      "message": "string",
      "fields": [
        "string"
      ]
    }
  ],
  "statusCode": 0
}

Example values show the shape of the data, not real values. See Using data from earlier steps.

Field descriptions

Field	Type	Description
id	Text	ID of the created record
success	Yes / No	True when Salesforce created the record
errors[]	List	Errors Salesforce reported. Empty on success: a failed create fails the node instead
errors[].statusCode	Text	Salesforce error code, e.g. REQUIRED_FIELD_MISSING
errors[].message	Text	Error message
errors[].fields[]	List	API names of the fields the error concerns
statusCode	Number	HTTP status code of the Salesforce response

Update Contact

Update a contact

Settings

Field	Type	Required	Description
Contact ID	Text	Yes	The ID of the contact to update
First Name	Text		The first name of the contact
Last Name	Text		The last name of the contact
Email	Text		The email of the contact
Phone	Text		The phone number of the contact
Account ID	Text		The ID of the account to associate with the contact
Title	Text		The job title of the contact
Department	Text		The department of the contact
Mailing Country	Choice (loaded from your account)		The country for mailing
Mailing Street	Text		The street address for mailing
Mailing City	Text		The city for mailing
Mailing State	Choice (loaded from your account)		The state/province for mailing
Mailing Postal Code	Text		The postal code for mailing

Output

Later steps use this data by picking this step in the $ picker. For example, contact is $.<step ID>.output.contact.

{
  "contact": {}
}

Example values show the shape of the data, not real values. See Using data from earlier steps.

Field descriptions

Field	Type	Description
contact	Any
contact.id	Text	ID of the written record
contact.success	Yes / No	True when Salesforce accepted the write
contact.data	Object	What the write returned or sent; the parent field's description says which

Create Lead

Create a new lead in Salesforce

Settings

Field	Type	Required	Description
First Name	Text		The first name of the lead
Last Name	Text	Yes	The last name of the lead
Company	Text	Yes	The company name
Email	Text		The email address of the lead
Phone	Text		The phone number of the lead
Title	Text		The job title of the lead
Status	Choice		The status of the lead Options: New, Contacted, Qualified, Unqualified
Lead Source	Choice		The source of the lead Options: Web, Phone Inquiry, Email, Campaign, Other
Industry	Choice		The industry of the lead
Rating	Choice		The rating of the lead Options: Hot, Warm, Cold
Description	Text		Additional description of the lead
Street	Text		The street address
City	Text		The city
Country	Choice (loaded from your account)		The country
State/Province	Choice (loaded from your account)		The state or province
Postal Code	Text		The postal code

Output

Later steps use this data by picking this step in the $ picker. For example, lead is $.<step ID>.output.lead.

{
  "lead": {}
}

Example values show the shape of the data, not real values. See Using data from earlier steps.

Field descriptions

Field	Type	Description
lead	Any
lead.id	Text	ID of the written record
lead.success	Yes / No	True when Salesforce accepted the write
lead.data	Object	What the write returned or sent; the parent field's description says which

Update Lead

Update an existing lead in Salesforce

Settings

Field	Type	Required	Description
Lead ID	Text	Yes	The ID of the lead to update
First Name	Text		The first name of the lead
Last Name	Text		The last name of the lead
Company	Text		The company name
Email	Text		The email address of the lead
Phone	Text		The phone number of the lead
Title	Text		The job title of the lead
Status	Choice		The status of the lead Options: New, Contacted, Qualified, Unqualified
Lead Source	Choice		The source of the lead Options: Web, Phone Inquiry, Email, Campaign, Other
Industry	Choice		The industry of the lead
Rating	Choice		The rating of the lead Options: Hot, Warm, Cold
Description	Text		Additional description of the lead
Street	Text		The street address
City	Text		The city
Country	Choice (loaded from your account)		The country
State/Province	Choice (loaded from your account)		The state or province
Postal Code	Text		The postal code

Output

Later steps use this data by picking this step in the $ picker. For example, lead is $.<step ID>.output.lead.

{
  "lead": {}
}

Example values show the shape of the data, not real values. See Using data from earlier steps.

Field descriptions

Field	Type	Description
lead	Any
lead.id	Text	ID of the written record
lead.success	Yes / No	True when Salesforce accepted the write
lead.data	Object	What the write returned or sent; the parent field's description says which

Convert Lead

Convert a lead to account, contact, and optionally opportunity

Settings

Field	Type	Required	Description
Lead ID	Text	Yes	The ID of the lead to convert
Converted Status	Choice		The status to set when converting the lead Options: Closed - Converted
Account ID	Text	Yes	The ID of the existing account to associate with
Opportunity ID	Text		The ID of the existing opportunity to associate with
Create Account	Yes / No		Whether to create a new account
Create Opportunity	Yes / No		Whether to create a new opportunity
Opportunity Name	Text		The name for the new opportunity

Output

Later steps use this data by picking this step in the $ picker. For example, success is $.<step ID>.output.success.

{
  "success": false,
  "accountId": "string",
  "contactId": "string",
  "opportunityId": "string"
}

Example values show the shape of the data, not real values. See Using data from earlier steps.

Field descriptions

Field	Type	Description
success	Yes / No	True when the lead was converted
accountId	Text	The ID of the created or associated account
contactId	Text	The ID of the created or associated contact
opportunityId	Text	The ID of the created or associated opportunity. Empty when none was created

Add Contact to Campaign

Add a contact to a campaign

Settings

Field	Type	Required	Description
Contact ID	Text	Yes	The ID of the contact to add to the campaign
Campaign ID	Text	Yes	The ID of the campaign to add the contact to

Output

Later steps use this data by picking this step in the $ picker. For example, id is $.<step ID>.output.id.

{
  "id": "string",
  "success": false,
  "errors": [
    {
      "statusCode": "REQUIRED_FIELD_MISSING",
      "message": "string",
      "fields": [
        "string"
      ]
    }
  ],
  "statusCode": 0
}

Example values show the shape of the data, not real values. See Using data from earlier steps.

Field descriptions

Field	Type	Description
id	Text	ID of the created record
success	Yes / No	True when Salesforce created the record
errors[]	List	Errors Salesforce reported. Empty on success: a failed create fails the node instead
errors[].statusCode	Text	Salesforce error code, e.g. REQUIRED_FIELD_MISSING
errors[].message	Text	Error message
errors[].fields[]	List	API names of the fields the error concerns
statusCode	Number	HTTP status code of the Salesforce response

Add Lead to Campaign

Add a lead to a campaign

Settings

Field	Type	Required	Description
Lead ID	Text	Yes	The ID of the lead to add to the campaign
Campaign ID	Text	Yes	The ID of the campaign to add the lead to

Output

Later steps use this data by picking this step in the $ picker. For example, id is $.<step ID>.output.id.

{
  "id": "string",
  "success": false,
  "errors": [
    {
      "statusCode": "REQUIRED_FIELD_MISSING",
      "message": "string",
      "fields": [
        "string"
      ]
    }
  ],
  "statusCode": 0
}

Example values show the shape of the data, not real values. See Using data from earlier steps.

Field descriptions

Field	Type	Description
id	Text	ID of the created record
success	Yes / No	True when Salesforce created the record
errors[]	List	Errors Salesforce reported. Empty on success: a failed create fails the node instead
errors[].statusCode	Text	Salesforce error code, e.g. REQUIRED_FIELD_MISSING
errors[].message	Text	Error message
errors[].fields[]	List	API names of the fields the error concerns
statusCode	Number	HTTP status code of the Salesforce response

Delete Record

Delete any type of record from Salesforce

Settings

Field	Type	Required	Description
Object Type	Choice (loaded from your account)	Yes	The type of Salesforce object to delete
Record ID	Text	Yes	The ID of the record to delete
Custom Object Name	Text		The name of the custom object (required when Object Type is 'Custom')

Output

Later steps use this data by picking this step in the $ picker. For example, success is $.<step ID>.output.success.

{
  "success": false,
  "recordId": "string",
  "objectType": "string"
}

Example values show the shape of the data, not real values. See Using data from earlier steps.

Field descriptions

Field	Type	Description
success	Yes / No	Whether the deletion was successful
recordId	Text	The ID of the deleted record
objectType	Text	The type of object that was deleted

Bulk Create Records

Create multiple records of the same type in bulk (max 200 records per request)

Settings

Field	Type	Required	Description
Records	List	Yes	Source records to create, as objects. data maps each Salesforce field API name to a $. path into the record, or to a fixed value
Is Job	Yes / No		Whether to create the records as a job
Object Type	Choice (loaded from your account)	Yes	The type of object to work with
Data Schema	Form	Yes	Data Schema of the records

Output

Later steps use this data by picking this step in the $ picker. For example, records[0].id is $.<step ID>.output.records[0].id.

{
  "records": [
    {
      "id": "string",
      "success": false,
      "errors": [
        "string"
      ],
      "data": {
        "errors": [],
        "id": "string",
        "success": false
      }
    }
  ],
  "objectType": "string",
  "success": false,
  "totalCount": 0,
  "successCount": 0,
  "errorCount": 0,
  "jobId": "string",
  "status": "string",
  "uploadResult": {}
}

Example values show the shape of the data, not real values. See Using data from earlier steps.

Field descriptions

Field	Type	Description
records[]	List	Without isJob: one result per record sent, in order. A record with item_N keys expands into several, so this can be longer than totalCount. Absent with isJob
records[].id	Text	ID of the created record. Empty when it failed
records[].success	Yes / No	True when the record was created. Omitted when it failed
records[].errors[]	List	Error messages for a failed record. Absent when it was created
records[].data	Object	Salesforce's result for this record
records[].data.errors[]	List	Errors Salesforce reported for this record
records[].data.errors[].statusCode	Text	Salesforce error code, e.g. REQUIRED_FIELD_MISSING
records[].data.errors[].message	Text	Error message
records[].data.errors[].fields[]	List	API names of the fields the error concerns
records[].data.id	Text	ID of the created record
records[].data.success	Yes / No	True when the record was created
objectType	Text	The type of object that was created
success	Yes / No	Without isJob: true when every record was created. With isJob: true once the job is created
totalCount	Number	Number of input records, before item_N expansion
successCount	Number	Number of records created successfully. Absent with isJob
errorCount	Number	Number of records that failed to create. Absent with isJob
jobId	Text	With isJob: ID of the Bulk API job. Pass it to checkJobStatus
status	Text	With isJob: JobCreated
uploadResult	Object	With isJob: Salesforce's response to the CSV upload

Check Job Status

Check the status of a bulk job in Salesforce

Settings

Field	Type	Required	Description
Job ID	Text	Yes	The ID of the bulk job to check

Output

Later steps use this data by picking this step in the $ picker. For example, id is $.<step ID>.output.id.

{
  "id": "string",
  "object": "string",
  "operation": "insert",
  "state": "string",
  "contentType": "string",
  "apiVersion": "string",
  "numberRecordsProcessed": 0,
  "numberRecordsFailed": 0
}

Example values show the shape of the data, not real values. See Using data from earlier steps.

Field descriptions

Field	Type	Description
id	Text	The ID of the job
object	Text	The Salesforce object type
operation	Text	The operation type (e.g., insert)
state	Text	The current state of the job
contentType	Text	The content type of the job
apiVersion	Text	The Salesforce API version
numberRecordsProcessed	Number	Number of records processed
numberRecordsFailed	Number	Number of records that failed

Create Record

Create a new record

Settings

Field	Type	Required	Description
Object Type	Choice (loaded from your account)	Yes	The type of object to work with
Data	Form	Yes	Data of the record

Output

Later steps use this data by picking this step in the $ picker. For example, objectType is $.<step ID>.output.objectType.

{
  "objectType": "Account",
  "record": {},
  "recordId": "string",
  "success": false
}

Example values show the shape of the data, not real values. See Using data from earlier steps.

Field descriptions

Field	Type	Description
objectType	Text	Salesforce object API name, e.g. Account
record	Any
record.id	Text	ID of the written record
record.success	Yes / No	True when Salesforce accepted the write
record.data	Object	What the write returned or sent; the parent field's description says which
recordId	Text	ID of the written record
success	Yes / No	True when Salesforce accepted the write

Update Record

Update an existing record

Settings

Field	Type	Required	Description
Record ID	Text	Yes	The ID of the record to update
Object Type	Choice (loaded from your account)	Yes	The type of object to work with
Data	Form	Yes	Data of the record

Output

Later steps use this data by picking this step in the $ picker. For example, objectType is $.<step ID>.output.objectType.

{
  "objectType": "Account",
  "record": {},
  "recordId": "string",
  "success": false
}

Example values show the shape of the data, not real values. See Using data from earlier steps.

Field descriptions

Field	Type	Description
objectType	Text	Salesforce object API name, e.g. Account
record	Any
record.id	Text	ID of the written record
record.success	Yes / No	True when Salesforce accepted the write
record.data	Object	What the write returned or sent; the parent field's description says which
recordId	Text	ID of the written record
success	Yes / No	True when Salesforce accepted the write