Skip to main content

Salesforce Connector

Salesforce Salesforce is a customer relationship management (CRM) platform. This component provides the ability to manage sales leads and records within the Salesforce platform.

API Documentation

This component was built using the following API References currently utilizing v63.0 by default.

Connections

Basic Authentication

Authenticate requests using Basic Authentication.

Prerequisites

  • A Salesforce account with API access enabled
  • The account's security token (if security tokens are enabled)

Setup Steps

When using Basic Auth, supply a Salesforce username and password. Depending on the Salesforce setup, the password may have a security token attached to it. If security tokens in the Salesforce account are disabled, the password to supply is simply the Salesforce password. If security tokens are enabled in the Salesforce account, then the password to enter is the concatenation of the password and the security token.

For example, if the Salesforce password is p@$sw0rD and the security token that Salesforce provides is ExAmPlE0000000000ExAmPlE, then enter p@$sw0rDExAmPlE0000000000ExAmPlE as the password. Manage security tokens by clicking the profile picture on the top-right of Salesforce, selecting My Settings, and then opening Personal -> Reset My Security Token.

Configure the Connection

Create a connection of type Basic Authentication and enter:

  • Username: Enter the Salesforce account username
  • Password: Enter the Salesforce password, or the password concatenated with the security token if security tokens are enabled
  • Login URL: Enter the Salesforce My Domain URL (e.g., https://my-company.my.salesforce.com/)
InputCommentsDefault
UsernameThe username of the Salesforce account
PasswordThe password of the Salesforce account
Login URLThe Salesforce Login URL for Basic Authentication (e.g., https://login.salesforce.com or a custom My Domain URL).

OAuth 2.0

Authenticate requests using OAuth 2.0.

OAuth 2.0 provides a simple way for users to authorize applications. To use OAuth 2.0, create and configure a Connected App within Salesforce.

Prerequisites

  • A Salesforce account with Administrator access
  • Permission to create Connected Apps in the Salesforce org

Setup Steps

  1. Log in to the Salesforce account
  2. Navigate to Setup by clicking the gear icon in the upper right corner
  3. Open Apps > External Client Apps > Settings
  4. Enable Allow creation of connected apps if it is not already enabled
  5. Select New Connected App
    • When creating the "Connected App" be sure to check Enable OAuth Settings, and enter the OAuth callback URL https://oauth2.integrations.acme.com/callback as a Callback URL.
    • Consult Salesforce to determine the proper OAuth Scopes to assign. To grant integrations the same permissions that the user authenticating through OAuth has, select Full access (full). Also select Perform requests at any time (refresh_token, offline_access). Select Require Secret for Web Server Flow and Require Secret for Refresh Token Flow:

Next select Save and Continue. Then, get the app's Consumer Key and Consumer Secret by selecting Manage Consumer Details. Take note of these keys:

To return to this screen, select Apps > App Manager, click the dropdown menu to the right of the app and select Edit. From there, manage callback URLs.

Configure the Connection

Create a connection of type OAuth 2.0 and enter:

  • Consumer Key: Enter the Consumer Key from the Connected App
  • Consumer Secret: Enter the Consumer Secret from the Connected App
  • Authorize URL: Defaults to https://login.salesforce.com/services/oauth2/authorize
  • Token URL: Defaults to https://login.salesforce.com/services/oauth2/token
  • Revoke URL: Defaults to https://login.salesforce.com/services/oauth2/revoke
Connecting to a Salesforce Sandbox Account

To connect to a Salesforce sandbox organization for testing purposes, edit the connection's Authorize URL, Token URL and Revoke URL to read test.salesforce.com instead of login.salesforce.com. Be sure to change these values back when testing is done.

This connection uses OAuth 2.0, a common authentication mechanism for integrations. Read about how OAuth 2.0 works here.

InputCommentsDefault
Authorize URLThe OAuth 2.0 Authorization URL for Salesforcehttps://login.salesforce.com/services/oauth2/authorize
Token URLThe OAuth 2.0 Token URL for Salesforcehttps://login.salesforce.com/services/oauth2/token
Revoke URLThe OAuth 2.0 Revocation URL for Salesforcehttps://login.salesforce.com/services/oauth2/revoke
Consumer KeyThe Consumer Key from the Salesforce Connected App.
Consumer SecretThe Consumer Secret from the Salesforce Connected App.

OAuth 2.0 Client Credentials

Authenticate using OAuth 2.0 Client Credentials for server-to-server integration.

OAuth 2.0 Client Credentials provides server-to-server authentication without user interaction. Use this connection type for integrations that run in the background without a user context.

Prerequisites

Setup Steps

This connection requires a Connected App configured for Client Credentials. If a Connected App already exists for OAuth 2.0, enable Client Credentials on that app. Otherwise, create a new Connected App following the OAuth 2.0 setup steps first.

  1. Enable Client Credentials Flow:

    1. Navigate to Setup > Apps > App Manager
    2. Find the Connected App and select Edit from the dropdown menu
    3. Under API (Enable OAuth Settings), check Enable Client Credentials Flow
    4. Click Save
  2. Configure Run As User — the Client Credentials flow requires specifying which user the integration will authenticate as:

    1. From the Connected App, select Manage from the dropdown menu
    2. Click Edit Policies
    3. Under Client Credentials Flow, select a user from the Run As dropdown
    4. Click Save

The selected user's permissions determine what the integration can access.

Configure the Connection

  • Instance URL: Enter the Salesforce My Domain URL (e.g., https://acme-corp.my.salesforce.com)
  • Consumer Key: Enter the Consumer Key from the Connected App
  • Consumer Secret: Enter the Consumer Secret from the Connected App
  • Scopes: Scopes are configured in the Salesforce Connected App settings
Connecting to a Salesforce Sandbox

For sandbox environments, use the sandbox My Domain URL format: https://your-company--sandbox.sandbox.my.salesforce.com

This connection uses OAuth 2.0, a common authentication mechanism for integrations. Read about how OAuth 2.0 works here.

InputCommentsDefault
Instance URLThe Salesforce My Domain URL (e.g., https://your-company.my.salesforce.com). For sandbox, use https://your-company--sandbox.sandbox.my.salesforce.com.
Consumer KeyThe Consumer Key from the Salesforce Connected App.
Consumer SecretThe Consumer Secret from the Salesforce Connected App.
ScopesScopes are configured in the Salesforce Connected App settings.

Triggers

Flow Outbound Message Webhook

Receive Flow-based outbound messages from Salesforce.

InputCommentsDefault
VersionThe Salesforce API version number to use for requests.63.0
PrefixSets a prefix to the Flow Name and Outbound Messages created. Must start with a letter, can contain letters, numbers, underscores, and be at most 15 characters.
Trigger Record TypeThe Salesforce object API name (e.g., Account, Contact) whose record changes will trigger this flow.
Trigger OnWhen to trigger the flow (record creation, update, or both).CreateAndUpdate
FieldsFields to include in the Outbound Message.
Flow MetadataAdditional Flow metadata in JSON format. This will be merged with other inputs.
Filter FormulaOptional formula to filter which records trigger the flow.
ConnectionThe Salesforce connection to use.

New and Updated Records

Checks for new, updated, and optionally deleted records in Salesforce on a recurring schedule.

InputCommentsDefault
ConnectionThe Salesforce connection to use.
Record TypeThe Salesforce object API name to act on (e.g., Account, Contact, Opportunity).
Show New RecordsWhen true, newly created records are included in the polling results.true
Show Updated RecordsWhen true, recently modified records are included in the polling results.true
Show Deleted RecordsWhen true, recently deleted records are included in the polling results.false
Selected FieldsSpecific field API names to include in results. Leave empty to return all fields. Id, CreatedDate, and LastModifiedDate are always included automatically.
Return IDs OnlyWhen true, only record IDs and date fields are returned (Id, CreatedDate, LastModifiedDate). Overrides Selected Fields. Use this to minimize data returned by the trigger.false
VersionThe Salesforce API version number to use for requests.63.0
Dynamic FieldsA field for dynamic inputs that can be configured at deploy time with the use of a key value config variable.
Field ValuesKey-value pairs mapping Salesforce field API names to the values to set on the record.
Field Value TypesFor each item, provide the key and the type corresponding to the field value entered above. Valid types are Boolean, Number, or String.
Max Records To FetchThe maximum number of records the trigger will fetch. Defaults to 20,000 records.20000

Webhook

Receive and validate webhook requests from Salesforce for manually configured webhook subscriptions.

Workflow Outbound Message Webhook (Deprecated)

Receive workflow rule outbound messages from Salesforce.

InputCommentsDefault
ConnectionThe Salesforce connection to use.
Record TypeThe Salesforce object API name to act on (e.g., Account, Contact, Opportunity).
Trigger TypeConditions in which the trigger fires. On All Changes: The workflow rule is considered on all changes. On Create Only: Considered on creation. On Create or Meets Rule Criteria: Considered on create and when it is updated to meet any Rule Criteria configured to the workflow rule.onAllChanges
Outbound Message NameThe name of the outbound message to be used.
Workflow Rule NameThe name of the workflow rule to be used.
DescriptionA text description of the object.
FieldsFields to include in the Outbound Message.
VersionThe Salesforce API version number to use for requests.63.0

Actions

Abort Bulk Job

Abort a bulk ingest job.

InputCommentsDefault
ConnectionThe Salesforce connection to use.
VersionThe Salesforce API version number to use for requests.63.0
Bulk Job IDThe unique identifier of the bulk job returned from the Create Bulk Job action.

Abort Bulk Query Job

Abort a bulk query job.

InputCommentsDefault
ConnectionThe Salesforce connection to use.
VersionThe Salesforce API version number to use for requests.63.0
Query Job IDThe ID of the query job to abort

Activate Flow

Activate a Flow in Salesforce by name.

InputCommentsDefault
VersionThe Salesforce API version number to use for requests.63.0
Flow NameThe name for the Flow. Accepts both display names and API names. Display names are automatically converted to API format, while API names are used as is.
ConnectionThe Salesforce connection to use.

Add Attachment

Attach a file to a parent record object (Account, Opportunity, etc.).

InputCommentsDefault
ConnectionThe Salesforce connection to use.
VersionThe Salesforce API version number to use for requests.63.0
Record IDThe unique identifier for a Salesforce record.
File NameThe name of the file to upload, including the file extension.
File ContentsReference a file from a previous step, or enter plain text here.

Add User Permission Set

Add a permission set to the specified user.

InputCommentsDefault
VersionThe Salesforce API version number to use for requests.63.0
User NameThe username of the Salesforce user to reference.
Permission SetThe name of the Salesforce Permission Set to assign to or remove from the user.
ConnectionThe Salesforce connection to use.

Bulk Insert Records

Create new Salesforce records in bulk.

InputCommentsDefault
VersionThe Salesforce API version number to use for requests.63.0
Record TypeThe Salesforce object API name to act on (e.g., Account, Contact, Opportunity).
External ID Field NameThe name of the column that refers to the External ID Field
FileThe binary file data to upload as a Salesforce Content Version.
ConnectionThe Salesforce connection to use.

Bulk Upsert Records

Update Salesforce records if they exist, otherwise create new Salesforce records.

InputCommentsDefault
VersionThe Salesforce API version number to use for requests.63.0
Record TypeThe Salesforce object API name to act on (e.g., Account, Contact, Opportunity).
External ID Field NameThe name of the column that refers to the External ID Field
FileThe binary file data to upload as a Salesforce Content Version.
ConnectionThe Salesforce connection to use.

Complete Upload Bulk Job

Notify Salesforce that the upload of job data is complete and ready for processing. No additional job data can be added after this call.

InputCommentsDefault
ConnectionThe Salesforce connection to use.
VersionThe Salesforce API version number to use for requests.63.0
Bulk Job IDThe unique identifier of the bulk job returned from the Create Bulk Job action.

Create Account

Create a Salesforce account record.

InputCommentsDefault
VersionThe Salesforce API version number to use for requests.63.0
Dynamic FieldsA field for dynamic inputs that can be configured at deploy time with the use of a key value config variable.
Field ValuesKey-value pairs mapping Salesforce field API names to the values to set on the record.
PhoneThe primary phone number for the object.
WebsiteThe website URL associated with the record.
Account TypeThe type of account record.
IndustryThe industry of the account record.
DescriptionA text description of the object.
Number of EmployeesThe number of employees associated with the object.
Annual RevenueThe estimated annual revenue of the account, in the organization's default currency.
Billing CityThe city of the object's billing address.
Billing Postal CodeThe zip code of the object's billing address.
Billing StateThe state of the object's billing address.
Billing Street AddressThe street address of the billing object.
Billing CountryThe country of the object's billing address.
Street AddressThe street address of the object.
StateThe state of the object's address.
CountryThe country of the object's address.
NameThe name assigned to the Salesforce record.
CityThe city of the object's address.
Postal CodeThe zip code of the object's address.
ConnectionThe Salesforce connection to use.

Create Bulk Job

Create a bulk ingest job representing an operation and its associated data for asynchronous processing in Salesforce.

InputCommentsDefault
ConnectionThe Salesforce connection to use.
VersionThe Salesforce API version number to use for requests.63.0
ObjectThe object type for the data being processed. Use only a single object type per job.
OperationThe data manipulation operation for the bulk job (e.g., insert, update, upsert, delete, or hardDelete).insert
External ID Field NameThe external ID field in the object being updated. Only needed for upsert operations. Field values must also exist in CSV job data.
Assignment Rule IDThe ID of an assignment rule to run for a Case or a Lead. The assignment rule can be active or inactive.
Column DelimiterThe character delimiter used to separate column values in the bulk query results file.COMMA
Line EndingThe line ending character sequence used in the bulk query results file.LF

Create Bulk Query Job

Create a bulk query job.

InputCommentsDefault
ConnectionThe Salesforce connection to use.
VersionThe Salesforce API version number to use for requests.63.0
OperationThe Salesforce Bulk API operation type. Use 'query' for standard queries and 'queryAll' to include deleted or archived records.query
QueryThe SOQL query to execute against the Salesforce Bulk API.
Column DelimiterThe character delimiter used to separate column values in the bulk query results file.COMMA
Line EndingThe line ending character sequence used in the bulk query results file.LF

Create Contact

Create a Salesforce contact.

InputCommentsDefault
Email AddressThe email address for the object.
VersionThe Salesforce API version number to use for requests.63.0
Dynamic FieldsA field for dynamic inputs that can be configured at deploy time with the use of a key value config variable.
Field ValuesKey-value pairs mapping Salesforce field API names to the values to set on the record.
PhoneThe primary phone number for the object.
First NameThe first name of the contact at the company
Last NameThe last name of the contact at the company
DepartmentThe department name associated with the contact.
BirthdateThe birthdate of the contact. Format: YYYY-MM-DD.
FaxThe fax number associated with the record.
TitleThe job title or professional title associated with the contact or lead.
Mobile PhoneThe mobile phone number for the object.
AssistantThe name of the contact's assistant.
Assistant's PhoneThe phone number of the contact's assistant.
DescriptionA text description of the object.
Billing CityThe city of the object's billing address.
Billing Postal CodeThe zip code of the object's billing address.
Billing StateThe state of the object's billing address.
Billing Street AddressThe street address of the billing object.
Billing CountryThe country of the object's billing address.
Street AddressThe street address of the object.
StateThe state of the object's address.
CountryThe country of the object's address.
CityThe city of the object's address.
Postal CodeThe zip code of the object's address.
ConnectionThe Salesforce connection to use.

Create Customer

Create a Salesforce customer.

InputCommentsDefault
VersionThe Salesforce API version number to use for requests.63.0
NameName of this customer.
Party IDThe unique identifier of the individual object related to this customer record.
Customer Status TypeThe status of the customer account.Active
Last Reference DateThe timestamp for when the current user last viewed a record related to this record.
Last Viewed DateThe timestamp for when the current user last viewed this record. If this value is null, it's possible that this record was referenced (LastReferencedDate) and not viewed.
Owner IDThe ID of the user who owns the record.
Total Lifetime ValueThe total revenue amount gained from this customer.
ConnectionThe Salesforce connection to use.

Create Flow

Create a draft Flow in Salesforce.

InputCommentsDefault
VersionThe Salesforce API version number to use for requests.63.0
Flow NameThe name for the Flow. Accepts both display names and API names. Display names are automatically converted to API format, while API names are used as is.
DescriptionA text description of the object.
Run In ModeThe context user mode the Flow runs as. DefaultMode respects user permissions and sharing rules. SystemModeWithoutSharing grants broad data access but may lead to security warnings.DefaultMode
Flow MetadataAdditional Flow metadata in JSON format. This will be merged with other inputs.
ConnectionThe Salesforce connection to use.

Create Lead

Create a Salesforce lead record.

InputCommentsDefault
VersionThe Salesforce API version number to use for requests.63.0
Dynamic FieldsA field for dynamic inputs that can be configured at deploy time with the use of a key value config variable.
Field ValuesKey-value pairs mapping Salesforce field API names to the values to set on the record.
First NameThe first name of the contact at the company
Last NameThe last name of the contact at the company
CompanyThe name of the company associated with the record.
TitleThe job title or professional title associated with the contact or lead.
PhoneThe primary phone number for the object.
Email AddressThe email address for the object.
Lead SourceThe origin or channel from which the lead was generated (e.g., Web, Phone, Email).
RatingThe rating for the lead.
WebsiteThe website URL associated with the record.
Street AddressThe street address of the object.
StateThe state of the object's address.
CityThe city of the object's address.
Postal CodeThe zip code of the object's address.
Number of EmployeesThe number of employees associated with the object.
DescriptionA text description of the object.
Annual RevenueThe estimated annual revenue of the account, in the organization's default currency.
Lead StatusThe status of the lead. Examples of valid values include: Open, Working, Closed - Converted, Closed - Not Converted.
ConnectionThe Salesforce connection to use.

Create Metadata

Create new metadata components.

InputCommentsDefault
ConnectionThe Salesforce connection to use.
VersionThe Salesforce API version number to use for requests.63.0
Metadata TypeThe type of metadata to act upon.CustomObject
MetadataSee JSforce Metadata API documentation for related documentation.
[
{
"fullName": "TestObject1__c",
"label": "Test Object 1",
"pluralLabel": "Test Object 1",
"nameField": {
"type": "Text",
"label": "Test Object Name"
},
"deploymentStatus": "Deployed",
"sharingModel": "ReadWrite"
}
]

Create Metadata Fields

Create custom fields from metadata.

InputCommentsDefault
ConnectionThe Salesforce connection to use.
VersionThe Salesforce API version number to use for requests.63.0
Metadata TypeThe type of metadata to act upon.CustomField
MetadataSee JSforce Metadata API documentation for related documentation.
[
{
"fullName": "Contact.FieldName1__c",
"label": "Field Name 1",
"type": "Text",
"length": 80,
"inlineHelpText": "Text that appears in the ? next to a field."
}
]

Create Opportunity

Create a Salesforce opportunity record representing a sale or pending deal.

InputCommentsDefault
VersionThe Salesforce API version number to use for requests.63.0
Next StepA description of the next action or milestone for the opportunity.
Dynamic FieldsA field for dynamic inputs that can be configured at deploy time with the use of a key value config variable.
Field ValuesKey-value pairs mapping Salesforce field API names to the values to set on the record.
AmountThe monetary amount associated with the opportunity.
Account IDThe ID of the account to reference.
StageThe stage the sale is currently in.
Opportunity TypeThe category of the opportunity, indicating whether it is for a new or existing customer.
Close DateThe date the sale is expected to close. Format: YYYY-MM-DD.
Lead SourceThe origin or channel from which the lead was generated (e.g., Web, Phone, Email).
ProbabilityThe probability of the success of the sale.
DescriptionA text description of the object.
NameThe name assigned to the Salesforce record.
ConnectionThe Salesforce connection to use.

Create Outbound Message

Create an Outbound Message in Salesforce.

InputCommentsDefault
VersionThe Salesforce API version number to use for requests.63.0
Record TypeThe Salesforce object API name to act on (e.g., Account, Contact, Opportunity).
Outbound Message NameThe name of the Salesforce Outbound Message to create or reference.
DescriptionA text description of the object.
Endpoint URLThe endpoint URL to send the outbound message / webhook to
Integration User EmailThe email of the user under which the payload is sent. If not provided, the current user will be used
FieldsFields to include in the Outbound Message.
Dynamic FieldsDynamic Fields, provided by value collection config variable, to include in the Outbound Message
ConnectionThe Salesforce connection to use.

Create Profile

Create a Salesforce profile.

InputCommentsDefault
VersionThe Salesforce API version number to use for requests.63.0
NameThe name of the profile.
DescriptionDescription of the profile.
PermissionsKey/value object with permission name keys and boolean value indicating if a permission is granted or not. Use 'Describe Permissions' to retrieve the permissions of a Record Type.
User LicenseIdentifier for associated UserLicense.
ConnectionThe Salesforce connection to use.

Create Record

Create a Salesforce record.

InputCommentsDefault
VersionThe Salesforce API version number to use for requests.63.0
Record TypeThe Salesforce object API name to act on (e.g., Account, Contact, Opportunity).
Dynamic FieldsA field for dynamic inputs that can be configured at deploy time with the use of a key value config variable.
Field ValuesKey-value pairs mapping Salesforce field API names to the values to set on the record.
ConnectionThe Salesforce connection to use.

Create User

Create a Salesforce user.

InputCommentsDefault
VersionThe Salesforce API version number to use for requests.63.0
Dynamic FieldsA field for dynamic inputs that can be configured at deploy time with the use of a key value config variable.
Field ValuesKey-value pairs mapping Salesforce field API names to the values to set on the record.
ProfileThe name of the Salesforce User Profile that defines the user's permissions and settings.
User NameThe username of the Salesforce user to reference.
First NameThe first name of the contact at the company
Last NameThe last name of the contact at the company
Time ZoneThe time zone for the user. Uses IANA format (e.g., America/New_York).
AliasA short identifier for the Salesforce user, typically used in reports and list views.
Email AddressThe email address for the object.
ConnectionThe Salesforce connection to use.

Create Workflow Rule

Create a Workflow Rule. Workflow Rules are deprecated by Salesforce; migrate to Flow-based actions.

InputCommentsDefault
VersionThe Salesforce API version number to use for requests.63.0
Record TypeThe Salesforce object API name to act on (e.g., Account, Contact, Opportunity).
Rule NameThe name of the Salesforce Workflow Rule to create or reference.
Trigger TypeConditions in which the trigger fires. On All Changes: The workflow rule is considered on all changes. On Create Only: Considered on creation. On Create or Meets Rule Criteria: Considered on create and when it is updated to meet any Rule Criteria configured to the workflow rule.onAllChanges
ActiveWhen true, the workflow rule is active and will fire when its criteria are met.true
DescriptionA text description of the object.
Rule Criteria FilterFilter criteria data structure to use with the rule, use this or Formula. See Salesforce Metadata API - FilterItem for the expected structure.
FormulaFormula to evaluate. Use this input or Filter Criteria
Outbound Message ActionsFull Names of the Outbound Message Actions for this Rule to fire.
ConnectionThe Salesforce connection to use.

Deactivate Flow

Deactivate a Flow in Salesforce by name.

InputCommentsDefault
VersionThe Salesforce API version number to use for requests.63.0
Flow NameThe name for the Flow. Accepts both display names and API names. Display names are automatically converted to API format, while API names are used as is.
ConnectionThe Salesforce connection to use.

Delete Account

Delete an existing account record.

InputCommentsDefault
VersionThe Salesforce API version number to use for requests.63.0
Field ValuesKey-value pairs mapping Salesforce field API names to the values to set on the record.
Record IDThe unique identifier for a Salesforce record.
ConnectionThe Salesforce connection to use.

Delete Bulk Job

Delete a bulk ingest job.

InputCommentsDefault
ConnectionThe Salesforce connection to use.
VersionThe Salesforce API version number to use for requests.63.0
Bulk Job IDThe unique identifier of the bulk job returned from the Create Bulk Job action.

Delete Bulk Query Job

Delete a bulk query job.

InputCommentsDefault
ConnectionThe Salesforce connection to use.
VersionThe Salesforce API version number to use for requests.63.0
Query Job IDThe ID of the query job to delete

Delete Contact

Delete an existing contact record.

InputCommentsDefault
VersionThe Salesforce API version number to use for requests.63.0
Record IDThe unique identifier for a Salesforce record.
ConnectionThe Salesforce connection to use.

Delete Customer

Delete an existing customer record.

InputCommentsDefault
VersionThe Salesforce API version number to use for requests.63.0
Record IDThe unique identifier for a Salesforce record.
ConnectionThe Salesforce connection to use.

Delete Flow

Delete a Flow from Salesforce by name.

InputCommentsDefault
VersionThe Salesforce API version number to use for requests.63.0
Flow NameThe name for the Flow. Accepts both display names and API names. Display names are automatically converted to API format, while API names are used as is.
ConnectionThe Salesforce connection to use.

Delete Instanced Flows and Outbound Messages

Delete all instanced flows and outbound messages for a given endpoint URL.

InputCommentsDefault
VersionThe Salesforce API version number to use for requests.63.0
Endpoint URLThe endpoint URL to delete the instanced flows and outbound messages for.
ConnectionThe Salesforce connection to use.

Delete Lead

Delete a Salesforce lead record.

InputCommentsDefault
VersionThe Salesforce API version number to use for requests.63.0
Record IDThe unique identifier for a Salesforce record.
ConnectionThe Salesforce connection to use.

Delete Metadata

Delete one or more metadata components.

InputCommentsDefault
ConnectionThe Salesforce connection to use.
Metadata TypeThe type of metadata to act upon.CustomObject
VersionThe Salesforce API version number to use for requests.63.0
Object Full NamesThe full API names of the Salesforce metadata objects to act on (e.g., TestObject1__c).

Delete Opportunity

Delete an existing opportunity record.

InputCommentsDefault
VersionThe Salesforce API version number to use for requests.63.0
Record IDThe unique identifier for a Salesforce record.
ConnectionThe Salesforce connection to use.

Delete Profile

Delete a Salesforce profile.

InputCommentsDefault
VersionThe Salesforce API version number to use for requests.63.0
Record IDThe unique identifier for a Salesforce record.
ConnectionThe Salesforce connection to use.

Delete Record

Delete an existing Salesforce record.

InputCommentsDefault
VersionThe Salesforce API version number to use for requests.63.0
Record TypeThe Salesforce object API name to act on (e.g., Account, Contact, Opportunity).
Record IDThe unique identifier for a Salesforce record.
ConnectionThe Salesforce connection to use.

Delete Workflow Outbound Message

Delete a Workflow Outbound Message.

InputCommentsDefault
VersionThe Salesforce API version number to use for requests.63.0
Full Name IdentifierThe unique full name identifier for Salesforce Metadata objects (e.g., CustomObject API name).
ConnectionThe Salesforce connection to use.

Delete Workflow Rule

Delete a Workflow Rule. Workflow Rules are deprecated by Salesforce; migrate to Flow-based actions.

InputCommentsDefault
VersionThe Salesforce API version number to use for requests.63.0
Full Name IdentifierThe unique full name identifier for Salesforce Metadata objects (e.g., CustomObject API name).
ConnectionThe Salesforce connection to use.

Describe Customer SObject

Describe metadata attributes of a Salesforce Customer object.

InputCommentsDefault
VersionThe Salesforce API version number to use for requests.63.0
ConnectionThe Salesforce connection to use.

Describe Object

Describe attributes of a Salesforce record type.

InputCommentsDefault
VersionThe Salesforce API version number to use for requests.63.0
Record TypeThe Salesforce object API name to act on (e.g., Account, Contact, Opportunity).
ConnectionThe Salesforce connection to use.

Describe Permissions

Describe permissions of a Salesforce record type.

InputCommentsDefault
VersionThe Salesforce API version number to use for requests.63.0
Record TypeThe Salesforce object API name to act on (e.g., Account, Contact, Opportunity).
ConnectionThe Salesforce connection to use.

Find Record

Find a single Salesforce record.

InputCommentsDefault
VersionThe Salesforce API version number to use for requests.63.0
Record TypeThe Salesforce object API name to act on (e.g., Account, Contact, Opportunity).
Dynamic FieldsA field for dynamic inputs that can be configured at deploy time with the use of a key value config variable.
Field ValuesKey-value pairs mapping Salesforce field API names to the values to set on the record.
Field Value TypesFor each item, provide the key and the type corresponding to the field value entered above. Valid types are Boolean, Number, or String.
ConnectionThe Salesforce connection to use.

Find Records

Find and fetch Salesforce records.

InputCommentsDefault
VersionThe Salesforce API version number to use for requests.63.0
Record TypeThe Salesforce object API name to act on (e.g., Account, Contact, Opportunity).
Dynamic FieldsA field for dynamic inputs that can be configured at deploy time with the use of a key value config variable.
Field ValuesKey-value pairs mapping Salesforce field API names to the values to set on the record.
Field Value TypesFor each item, provide the key and the type corresponding to the field value entered above. Valid types are Boolean, Number, or String.
Page SizeThe maximum number of results to return per page when paginating results.
Page NumberThe page number to retrieve when paginating results. Uses 1-based indexing.
Sort CriteriaThe criteria by which to sort the records. Use a string to specify the field and order. Prefix with '-' for descending order. For example, '-CreatedDate Name' will sort by 'CreatedDate' in descending order and by 'Name' in ascending order.
Fetch AllWhen true, automatically fetches all pages of results instead of a single page.false
Max Records To FetchThe maximum number of records to fetch when Fetch All is enabled. Defaults to 20,000 records.20000
ConnectionThe Salesforce connection to use.

Get Attachment

Get a file attachment from an account, opportunity, or contact.

InputCommentsDefault
ConnectionThe Salesforce connection to use.
VersionThe Salesforce API version number to use for requests.63.0
File IDThe unique identifier of the file to retrieve.

Get Bulk Job Failed Record Results

Retrieve a list of failed records for a completed insert, delete, update, or upsert bulk job.

InputCommentsDefault
ConnectionThe Salesforce connection to use.
VersionThe Salesforce API version number to use for requests.63.0
Bulk Job IDThe unique identifier of the bulk job returned from the Create Bulk Job action.

Get Bulk Job Information

Retrieve information about a bulk ingest job.

InputCommentsDefault
ConnectionThe Salesforce connection to use.
VersionThe Salesforce API version number to use for requests.63.0
Bulk Job IDThe unique identifier of the bulk job returned from the Create Bulk Job action.

Get Bulk Job Successful Record Results

Retrieve the successful record results for a bulk ingest job.

InputCommentsDefault
ConnectionThe Salesforce connection to use.
VersionThe Salesforce API version number to use for requests.63.0
Bulk Job IDThe unique identifier of the bulk job returned from the Create Bulk Job action.

Get Bulk Query Job Information

Get information about a single bulk query job.

InputCommentsDefault
ConnectionThe Salesforce connection to use.
VersionThe Salesforce API version number to use for requests.63.0
Query Job IDThe unique identifier of the bulk query job returned from the Create Bulk Query Job action.

Get Bulk Query Job Results

Retrieve the results for a completed bulk query job.

InputCommentsDefault
ConnectionThe Salesforce connection to use.
VersionThe Salesforce API version number to use for requests.63.0
Query Job IDThe unique identifier of the bulk query job returned from the Create Bulk Query Job action.
LocatorA string that identifies a specific set of query results. Providing a value for this parameter returns only that set of results.
Max RecordsThe maximum number of records to retrieve per set of results for the query. The request is still subject to the size limits.

Get Current User

Retrieve information about the currently authenticated user.

InputCommentsDefault
VersionThe Salesforce API version number to use for requests.63.0
ConnectionThe Salesforce connection to use.

Get Customer

Retrieve a customer record by ID.

InputCommentsDefault
VersionThe Salesforce API version number to use for requests.63.0
Record IDThe unique identifier for a Salesforce record.
ConnectionThe Salesforce connection to use.

Get File

Retrieve a file from Salesforce ContentVersion.

InputCommentsDefault
Content Version IDThe unique identifier of the ContentVersion record for the file to retrieve.
VersionThe Salesforce API version number to use for requests.63.0
ConnectionThe Salesforce connection to use.

Get Flow

Get details of a specific Flow by name.

InputCommentsDefault
VersionThe Salesforce API version number to use for requests.63.0
Flow NameThe name for the Flow. Accepts both display names and API names. Display names are automatically converted to API format, while API names are used as is.
ConnectionThe Salesforce connection to use.

Get Object Metadata

Get the metadata of an object by full name.

InputCommentsDefault
ConnectionThe Salesforce connection to use.
Metadata TypeThe type of metadata to act upon.CustomObject
VersionThe Salesforce API version number to use for requests.63.0
Object Full NameThe full API name of the Salesforce custom object (e.g., Widget__c).

Get Record

Get a single Salesforce record by ID.

InputCommentsDefault
VersionThe Salesforce API version number to use for requests.63.0
Record TypeThe Salesforce object API name to act on (e.g., Account, Contact, Opportunity).
Record IDThe unique identifier for a Salesforce record.
ConnectionThe Salesforce connection to use.

List All Bulk Query Job Information

Retrieve information about all bulk query jobs in the org.

InputCommentsDefault
ConnectionThe Salesforce connection to use.
VersionThe Salesforce API version number to use for requests.63.0
Is PK Chunking EnabledWhen true, the request only returns information about jobs where PK Chunking is enabled. This only applies to Bulk API (not Bulk API 2.0) jobs.false
Job TypeGets information only about jobs matching the specified job type.
Concurrency ModeFor future use. Gets information only about jobs matching the specified concurrency mode.parallel
Query LocatorA string that identifies a specific set of query results. Providing a value for this parameter returns only that set of results.

List Bulk Jobs

List all bulk ingest jobs in the org.

InputCommentsDefault
ConnectionThe Salesforce connection to use.
VersionThe Salesforce API version number to use for requests.63.0
Is PK Chunking EnabledWhen true, the request only returns information about jobs where PK Chunking is enabled. This only applies to Bulk API (not Bulk API 2.0) jobs.false
Job TypeGets information only about jobs matching the specified job type.
LocatorA string that identifies a specific set of query results. Providing a value for this parameter returns only that set of results.

List Composite Resources

Retrieve a list of URIs for available composite resources.

InputCommentsDefault
ConnectionThe Salesforce connection to use.
VersionThe Salesforce API version number to use for requests.63.0

List Contacts

List all contact records.

InputCommentsDefault
VersionThe Salesforce API version number to use for requests.63.0
Dynamic FieldsA field for dynamic inputs that can be configured at deploy time with the use of a key value config variable.
Field ValuesKey-value pairs mapping Salesforce field API names to the values to set on the record.
Field Value TypesFor each item, provide the key and the type corresponding to the field value entered above. Valid types are Boolean, Number, or String.
Page SizeThe maximum number of results to return per page when paginating results.
Page NumberThe page number to retrieve when paginating results. Uses 1-based indexing.
Sort CriteriaThe criteria by which to sort the records. Use a string to specify the field and order. Prefix with '-' for descending order. For example, '-CreatedDate Name' will sort by 'CreatedDate' in descending order and by 'Name' in ascending order.
Fetch AllWhen true, automatically fetches all pages of results instead of a single page.false
Max Records To FetchThe maximum number of records to fetch when Fetch All is enabled. Defaults to 20,000 records.20000
ConnectionThe Salesforce connection to use.

List Customers

List all customer records.

InputCommentsDefault
VersionThe Salesforce API version number to use for requests.63.0
Dynamic FieldsA field for dynamic inputs that can be configured at deploy time with the use of a key value config variable.
Field ValuesKey-value pairs mapping Salesforce field API names to the values to set on the record.
Field Value TypesFor each item, provide the key and the type corresponding to the field value entered above. Valid types are Boolean, Number, or String.
Page SizeThe maximum number of results to return per page when paginating results.
Page NumberThe page number to retrieve when paginating results. Uses 1-based indexing.
Sort CriteriaThe criteria by which to sort the records. Use a string to specify the field and order. Prefix with '-' for descending order. For example, '-CreatedDate Name' will sort by 'CreatedDate' in descending order and by 'Name' in ascending order.
Fetch AllWhen true, automatically fetches all pages of results instead of a single page.false
Max Records To FetchThe maximum number of records to fetch when Fetch All is enabled. Defaults to 20,000 records.20000
ConnectionThe Salesforce connection to use.

List Flows

List all Flows in the Salesforce org.

InputCommentsDefault
VersionThe Salesforce API version number to use for requests.63.0
ConnectionThe Salesforce connection to use.

List Leads

List all lead records.

InputCommentsDefault
VersionThe Salesforce API version number to use for requests.63.0
Dynamic FieldsA field for dynamic inputs that can be configured at deploy time with the use of a key value config variable.
Field ValuesKey-value pairs mapping Salesforce field API names to the values to set on the record.
Field Value TypesFor each item, provide the key and the type corresponding to the field value entered above. Valid types are Boolean, Number, or String.
Page SizeThe maximum number of results to return per page when paginating results.
Page NumberThe page number to retrieve when paginating results. Uses 1-based indexing.
Sort CriteriaThe criteria by which to sort the records. Use a string to specify the field and order. Prefix with '-' for descending order. For example, '-CreatedDate Name' will sort by 'CreatedDate' in descending order and by 'Name' in ascending order.
Fetch AllWhen true, automatically fetches all pages of results instead of a single page.false
Max Records To FetchThe maximum number of records to fetch when Fetch All is enabled. Defaults to 20,000 records.20000
ConnectionThe Salesforce connection to use.

List Metadata

List all metadata components in Salesforce.

InputCommentsDefault
ConnectionThe Salesforce connection to use.
Metadata TypeThe type of metadata to act upon.CustomObject
VersionThe Salesforce API version number to use for requests.63.0

List Opportunities

List all opportunity records.

InputCommentsDefault
VersionThe Salesforce API version number to use for requests.63.0
Dynamic FieldsA field for dynamic inputs that can be configured at deploy time with the use of a key value config variable.
Field ValuesKey-value pairs mapping Salesforce field API names to the values to set on the record.
Field Value TypesFor each item, provide the key and the type corresponding to the field value entered above. Valid types are Boolean, Number, or String.
Page SizeThe maximum number of results to return per page when paginating results.
Page NumberThe page number to retrieve when paginating results. Uses 1-based indexing.
Sort CriteriaThe criteria by which to sort the records. Use a string to specify the field and order. Prefix with '-' for descending order. For example, '-CreatedDate Name' will sort by 'CreatedDate' in descending order and by 'Name' in ascending order.
Fetch AllWhen true, automatically fetches all pages of results instead of a single page.false
Max Records To FetchThe maximum number of records to fetch when Fetch All is enabled. Defaults to 20,000 records.20000
ConnectionThe Salesforce connection to use.

List Outbound Messages

Retrieve all Outbound Messages in the Salesforce org.

InputCommentsDefault
VersionThe Salesforce API version number to use for requests.63.0
ConnectionThe Salesforce connection to use.

List Profiles

List all profile records.

InputCommentsDefault
VersionThe Salesforce API version number to use for requests.63.0
Dynamic FieldsA field for dynamic inputs that can be configured at deploy time with the use of a key value config variable.
Field ValuesKey-value pairs mapping Salesforce field API names to the values to set on the record.
Field Value TypesFor each item, provide the key and the type corresponding to the field value entered above. Valid types are Boolean, Number, or String.
Page SizeThe maximum number of results to return per page when paginating results.
Page NumberThe page number to retrieve when paginating results. Uses 1-based indexing.
Sort CriteriaThe criteria by which to sort the records. Use a string to specify the field and order. Prefix with '-' for descending order. For example, '-CreatedDate Name' will sort by 'CreatedDate' in descending order and by 'Name' in ascending order.
Fetch AllWhen true, automatically fetches all pages of results instead of a single page.false
Max Records To FetchThe maximum number of records to fetch when Fetch All is enabled. Defaults to 20,000 records.20000
ConnectionThe Salesforce connection to use.

List Users

List all user records.

InputCommentsDefault
VersionThe Salesforce API version number to use for requests.63.0
Dynamic FieldsA field for dynamic inputs that can be configured at deploy time with the use of a key value config variable.
Field ValuesKey-value pairs mapping Salesforce field API names to the values to set on the record.
Field Value TypesFor each item, provide the key and the type corresponding to the field value entered above. Valid types are Boolean, Number, or String.
Page SizeThe maximum number of results to return per page when paginating results.
Page NumberThe page number to retrieve when paginating results. Uses 1-based indexing.
Sort CriteriaThe criteria by which to sort the records. Use a string to specify the field and order. Prefix with '-' for descending order. For example, '-CreatedDate Name' will sort by 'CreatedDate' in descending order and by 'Name' in ascending order.
Fetch AllWhen true, automatically fetches all pages of results instead of a single page.false
Max Records To FetchThe maximum number of records to fetch when Fetch All is enabled. Defaults to 20,000 records.20000
ConnectionThe Salesforce connection to use.

List Workflow Rules

List all Workflow Rules. Workflow Rules are deprecated by Salesforce; migrate to Flow-based actions.

InputCommentsDefault
VersionThe Salesforce API version number to use for requests.63.0
ConnectionThe Salesforce connection to use.

Query

Run an SOQL query against Salesforce.

InputCommentsDefault
VersionThe Salesforce API version number to use for requests.63.0
SOQL QueryA Salesforce Object Query Language (SOQL) query to execute against the Salesforce API.
ConnectionThe Salesforce connection to use.

Raw Request

Send raw HTTP request to Salesforce.

InputCommentsDefault
ConnectionThe Salesforce connection to use.
VersionThe Salesforce API version number to use for requests.63.0
URLInput the path only (/chatter/feeds/record/), The base URL is already included (https://<YOUR_INSTANCE_URL_COMING_FROM_CONNECTION>/services/data/v<YOUR_INPUT_VERSION>). For example, to connect to https://instance_name/services/data/v58.0/chatter/feeds/record/, only /chatter/feeds/record/ is entered in this field.
MethodThe HTTP method to use.
DataThe HTTP body payload to send to the URL.
Form DataThe Form Data to be sent as a multipart form upload.
File DataFile Data to be sent as a multipart form upload.
File Data File NamesFile names to apply to the file data inputs. Keys must match the file data keys above.
Query ParameterA list of query parameters to send with the request. This is the portion at the end of the URL similar to ?key1=value1&key2=value2.
HeaderA list of headers to send with the request.
Response TypeThe type of data you expect in the response. You can request json, text, or binary data.json
TimeoutThe maximum time that a client will await a response to its request
Retry Delay (ms)The delay in milliseconds between retries. This is used when 'Use Exponential Backoff' is disabled.0
Retry On All ErrorsIf true, retries on all erroneous responses regardless of type. This is helpful when retrying after HTTP 429 or other 3xx or 4xx errors. Otherwise, only retries on HTTP 5xx and network errors.false
Max Retry CountThe maximum number of retries to attempt. Specify 0 for no retries.0
Use Exponential BackoffSpecifies whether to use a pre-defined exponential backoff strategy for retries. When enabled, 'Retry Delay (ms)' is ignored.false

Remove User Permission Set

Remove a permission set from the specified user.

InputCommentsDefault
VersionThe Salesforce API version number to use for requests.63.0
User NameThe username of the Salesforce user to reference.
Permission SetThe name of the Salesforce Permission Set to assign to or remove from the user.
ConnectionThe Salesforce connection to use.

Send Composite Request

Send multiple requests in a single HTTP call.

InputCommentsDefault
ConnectionThe Salesforce connection to use.
VersionThe Salesforce API version number to use for requests.63.0
All Or NoneWhen true, any error in a subrequest causes the entire composite request to be rolled back. The top-level request returns HTTP 200 and includes responses for each subrequest.true
Collate SubrequestsWhen true, the API collates unrelated subrequests to bulkify them for improved performance.false
Composite RequestThe JSON array of subrequests to execute in a single Composite API call. Each entry must include method, url, referenceId, and optionally body.

Send Transactional Email

Send a transactional email message to a single recipient via Salesforce.

InputCommentsDefault
Message KeyThe unique key identifying the transactional message template to send.
Definition KeyThe unique key of the message template definition used for the transactional send.
Recipient Contact KeyThe unique key identifying the recipient contact in Salesforce Marketing Cloud.
Recipient EmailThe email address of the recipient for the transactional send.
Recipient AttributesKey-value pairs to personalize the message.
ConnectionThe Salesforce connection to use.
VersionThe Salesforce API version number to use for requests.63.0

Subscribe to Record Change

Create a Workflow Rule to subscribe to record changes in Salesforce. Workflow Rules are deprecated by Salesforce; migrate to Flow-based actions.

InputCommentsDefault
VersionThe Salesforce API version number to use for requests.63.0
Outbound Message NameThe name of the Salesforce Outbound Message to create or reference.
Record TypeThe Salesforce object API name to act on (e.g., Account, Contact, Opportunity).
Trigger EventThe event condition that causes this workflow rule to fire.onAllChanges
Endpoint URLThe endpoint URL to send the outbound message / webhook to
Rule Criteria FilterFilter criteria data structure to use with the rule, use this or Formula. See Salesforce Metadata API - FilterItem for the expected structure.
FormulaFormula to evaluate. Use this input or Filter Criteria
Integration User EmailThe email of the user under which the payload is sent. If not provided, the current user will be used
DescriptionA text description of the object.
FieldsFields to include in the Outbound Message.
Dynamic FieldsDynamic Fields, provided by value collection config variable, to include in the Outbound Message
ConnectionThe Salesforce connection to use.

Subscribe to Record Changes

Subscribe to Record Changes in Salesforce using an outbound message action.

InputCommentsDefault
VersionThe Salesforce API version number to use for requests.63.0
PrefixSets a prefix to the Flow Name and Outbound Messages created. Must start with a letter, can contain letters, numbers, underscores, and be at most 15 characters.
Endpoint URLThe endpoint URL to send the outbound message / webhook to
Trigger Record TypeThe Salesforce object API name (e.g., Account, Contact) whose record changes will trigger this flow.
Trigger OnWhen to trigger the flow (record creation, update, or both).CreateAndUpdate
FieldsFields to include in the Outbound Message.
Dynamic FieldsDynamic Fields, provided by value collection config variable, to include in the Outbound Message
Flow MetadataAdditional Flow metadata in JSON format. This will be merged with other inputs.
Filter FormulaOptional formula to filter which records trigger the flow.
ConnectionThe Salesforce connection to use.

Update Account

Update an existing account record.

InputCommentsDefault
Record IDThe unique identifier for a Salesforce record.
VersionThe Salesforce API version number to use for requests.63.0
Dynamic FieldsA field for dynamic inputs that can be configured at deploy time with the use of a key value config variable.
Field ValuesKey-value pairs mapping Salesforce field API names to the values to set on the record.
PhoneThe primary phone number for the object.
WebsiteThe website URL associated with the record.
Account TypeThe type of account record.
IndustryThe industry of the account record.
DescriptionA text description of the object.
Number of EmployeesThe number of employees associated with the object.
Annual RevenueThe estimated annual revenue of the account, in the organization's default currency.
Billing CityThe city of the object's billing address.
Billing Postal CodeThe zip code of the object's billing address.
Billing StateThe state of the object's billing address.
Billing Street AddressThe street address of the billing object.
Billing CountryThe country of the object's billing address.
Street AddressThe street address of the object.
StateThe state of the object's address.
CountryThe country of the object's address.
NameThe name assigned to the Salesforce record.
CityThe city of the object's address.
Postal CodeThe zip code of the object's address.
ConnectionThe Salesforce connection to use.

Update Contact

Update an existing contact record.

InputCommentsDefault
Record IDThe unique identifier for a Salesforce record.
Email AddressThe email address for the object.
VersionThe Salesforce API version number to use for requests.63.0
Dynamic FieldsA field for dynamic inputs that can be configured at deploy time with the use of a key value config variable.
Field ValuesKey-value pairs mapping Salesforce field API names to the values to set on the record.
PhoneThe primary phone number for the object.
First NameThe first name of the contact at the company
Last NameThe last name of the contact at the company
DepartmentThe department name associated with the contact.
BirthdateThe birthdate of the contact. Format: YYYY-MM-DD.
FaxThe fax number associated with the record.
TitleThe job title or professional title associated with the contact or lead.
Mobile PhoneThe mobile phone number for the object.
AssistantThe name of the contact's assistant.
Assistant's PhoneThe phone number of the contact's assistant.
DescriptionA text description of the object.
Billing CityThe city of the object's billing address.
Billing Postal CodeThe zip code of the object's billing address.
Billing StateThe state of the object's billing address.
Billing Street AddressThe street address of the billing object.
Billing CountryThe country of the object's billing address.
Street AddressThe street address of the object.
StateThe state of the object's address.
CountryThe country of the object's address.
CityThe city of the object's address.
Postal CodeThe zip code of the object's address.
ConnectionThe Salesforce connection to use.

Update Customer

Update an existing customer record.

InputCommentsDefault
Record IDThe unique identifier for a Salesforce record.
VersionThe Salesforce API version number to use for requests.63.0
NameName of this customer.
Party IDThe unique identifier of the individual object related to this customer record.
Customer Status TypeThe status of the customer account.Active
Last Reference DateThe timestamp for when the current user last viewed a record related to this record.
Last Viewed DateThe timestamp for when the current user last viewed this record. If this value is null, it's possible that this record was referenced (LastReferencedDate) and not viewed.
Owner IDThe ID of the user who owns the record.
Total Lifetime ValueThe total revenue amount gained from this customer.
ConnectionThe Salesforce connection to use.

Update Flow

Update an existing Flow in Salesforce by name.

InputCommentsDefault
VersionThe Salesforce API version number to use for requests.63.0
Flow NameThe name for the Flow. Accepts both display names and API names. Display names are automatically converted to API format, while API names are used as is.
DescriptionUpdated description for the Flow.
Flow StatusThe publication status of the Flow. Active flows execute when triggered; Draft and Obsolete flows do not.
Flow MetadataAdditional Flow metadata in JSON format. This will be merged with other inputs.
ConnectionThe Salesforce connection to use.

Update Lead

Update a Salesforce lead record.

InputCommentsDefault
Record IDThe unique identifier for a Salesforce record.
VersionThe Salesforce API version number to use for requests.63.0
CompanyThe name of the company associated with the record.
Email AddressThe email address for the object.
Lead StatusThe status of the lead. Examples of valid values include: Open, Working, Closed - Converted, Closed - Not Converted.
Dynamic FieldsA field for dynamic inputs that can be configured at deploy time with the use of a key value config variable.
Field ValuesKey-value pairs mapping Salesforce field API names to the values to set on the record.
First NameThe first name of the contact at the company
Last NameThe last name of the contact at the company
TitleThe job title or professional title associated with the contact or lead.
PhoneThe primary phone number for the object.
Lead SourceThe origin or channel from which the lead was generated (e.g., Web, Phone, Email).
RatingThe rating for the lead.
WebsiteThe website URL associated with the record.
Street AddressThe street address of the object.
StateThe state of the object's address.
CityThe city of the object's address.
Postal CodeThe zip code of the object's address.
Number of EmployeesThe number of employees associated with the object.
DescriptionA text description of the object.
Annual RevenueThe estimated annual revenue of the account, in the organization's default currency.
ConnectionThe Salesforce connection to use.

Update Metadata

Update one or more metadata components.

InputCommentsDefault
ConnectionThe Salesforce connection to use.
VersionThe Salesforce API version number to use for requests.63.0
Metadata TypeThe type of metadata to act upon.CustomField
MetadataCheck https://jsforce.github.io/document/#update-metadata for related documentation

Update Opportunity

Update an existing opportunity record.

InputCommentsDefault
Record IDThe unique identifier for a Salesforce record.
Next StepA description of the next action or milestone for the opportunity.
VersionThe Salesforce API version number to use for requests.63.0
Dynamic FieldsA field for dynamic inputs that can be configured at deploy time with the use of a key value config variable.
Field ValuesKey-value pairs mapping Salesforce field API names to the values to set on the record.
AmountThe monetary amount associated with the opportunity.
StageThe stage the sale is currently in.
Account IDThe ID of the account to reference.
Opportunity TypeThe category of the opportunity, indicating whether it is for a new or existing customer.
Close DateThe date the sale is expected to close. Format: YYYY-MM-DD.
Lead SourceThe origin or channel from which the lead was generated (e.g., Web, Phone, Email).
ProbabilityThe probability of the success of the sale.
DescriptionA text description of the object.
NameThe name assigned to the Salesforce record.
ConnectionThe Salesforce connection to use.

Update Profile

Update a Salesforce profile.

InputCommentsDefault
VersionThe Salesforce API version number to use for requests.63.0
Record IDThe unique identifier for a Salesforce record.
NameThe name of the profile.
DescriptionDescription of the profile.
PermissionsKey/value object with permission name keys and boolean value indicating if a permission is granted or not. Use 'Describe Permissions' to retrieve the permissions of a Record Type.
ConnectionThe Salesforce connection to use.

Update Record

Update an existing Salesforce record.

InputCommentsDefault
VersionThe Salesforce API version number to use for requests.63.0
Record TypeThe Salesforce object API name to act on (e.g., Account, Contact, Opportunity).
Record IDThe unique identifier for a Salesforce record.
Dynamic FieldsA field for dynamic inputs that can be configured at deploy time with the use of a key value config variable.
Field ValuesKey-value pairs mapping Salesforce field API names to the values to set on the record.
ConnectionThe Salesforce connection to use.

Update User

Update a Salesforce user.

InputCommentsDefault
VersionThe Salesforce API version number to use for requests.63.0
User NameThe username of the Salesforce user to reference.
Dynamic FieldsA field for dynamic inputs that can be configured at deploy time with the use of a key value config variable.
Field ValuesKey-value pairs mapping Salesforce field API names to the values to set on the record.
ConnectionThe Salesforce connection to use.

Upload Bulk Job Data

Upload CSV data for a bulk ingest job.

InputCommentsDefault
ConnectionThe Salesforce connection to use.
VersionThe Salesforce API version number to use for requests.63.0
Bulk Job IDThe unique identifier of the bulk job returned from the Create Bulk Job action.
FileThe binary file data to upload as a Salesforce Content Version.

Upload File

Upload a file to Salesforce ContentVersion.

InputCommentsDefault
VersionThe Salesforce API version number to use for requests.63.0
ConnectionThe Salesforce connection to use.
FileThe binary file data to upload as a Salesforce Content Version.
Path On ClientThe complete path of the document. One of the fields that determines the FileType. Specify a complete path including the path extension in order for the document to be visible in the Preview tab.

Upsert Record

Update a Salesforce record if it exists, otherwise create a new Salesforce record.

InputCommentsDefault
VersionThe Salesforce API version number to use for requests.63.0
Record TypeThe Salesforce object API name to act on (e.g., Account, Contact, Opportunity).
External ID Field NameThe name of the column that refers to the External ID Field
RecordsThe JSON array of records to be upserted. Each record must include the external ID field.
ConnectionThe Salesforce connection to use.

Validate Connection

Validate the provided connection and return whether it is valid.

InputCommentsDefault
VersionThe Salesforce API version number to use for requests.63.0
ConnectionThe Salesforce connection to use.