Salesforce Update

Salesforce Update

Certified
Enterprise Edition

Update Salesforce records

Apply field changes to existing records via the Partner API. Each record must include its Id.

yaml
type: io.kestra.plugin.ee.salesforce.Update

Update Contact records in Salesforce.

yaml
id: update_contacts
namespace: company.sales

tasks:
  - id: update_contacts_task
    type: io.kestra.plugin.ee.salesforce.Update
    connection:
      username: "{{ secret('SALESFORCE_USERNAME') }}"
      password: "{{ secret('SALESFORCE_PASSWORD') }}"
      authEndpoint: "{{ secret('SALESFORCE_AUTH_ENDPOINT') }}"
    objectName: "Contact"
    records:
      - Id: "003XXXXXXXXXXXXAAA"
        Email: "updated.john@example.com"
      - Id: "003XXXXXXXXXXXXAAB"
        Email: "updated.jane@example.com"
Installation

This Enterprise plugin requires an Enterprise image and access to the plugin registry. Install it with the following command:

kestractl plugins get io.kestra.plugin.ee:plugin-ee-salesforce --compatible-for $KESTRA_VERSION

For kestractl, use your Kestra version with --compatible-for, or specify an exact plugin version.

For Kestra CLI, replace LATEST with a specific version or version range to pin the plugin version.

Properties

Salesforce connection

Partner API credentials using username/password with auth endpoint or access token with instance URL.

Definitions
accessTokenstring

Salesforce access token

Session or OAuth access token. When set, username and password are ignored; requires instanceUrl.

authEndpointstring
Defaulthttps://login.salesforce.com/services/Soap/u/63.0/

Salesforce authentication endpoint

SOAP login endpoint used with username/password. Defaults to https://login.salesforce.com/services/Soap/u/63.0/.

instanceUrlstring

Salesforce instance URL

Instance base URL required with accessToken (for example https://mydomain.my.salesforce.com).

passwordstring

Salesforce password

Password for SOAP authentication (append the security token when required, for example <password><token>). Only used when accessToken is empty. For more details, refer to the Salesforce Documentation.

usernamestring

Salesforce username

Username for SOAP authentication. Ignored when accessToken is provided.

Target Salesforce object

API name of the object to update (for example Account, Contact). See Salesforce Standard Objects.

SubTypeobject

Records to update

Array of field maps to update. Each entry must include Id plus the fields to change; null values are ignored.

Assets this task consumes as inputs or produces as outputs, for lineage tracking and the asset graph (Enterprise Edition). A flow declaring this property on a task is rejected in the open-source edition.

Definitions
assetFailureBehaviorstring
Possible Values
IGNOREFAILWARN

Asset failure behavior

Behavior applied to the task state when a declared asset fails to render, emit, or be persisted (e.g. a lock conflict): FAIL escalates it to FAILED, WARN (default) warns it if it would otherwise succeed, IGNORE leaves the state untouched.

enableAutobooleanstring

Whether to auto-register assets referenced dynamically at runtime that are not statically declared in inputs or outputs.

inputsarray

The assets consumed as inputs.

id*string
Min length1
typestring
outputs

The assets produced as outputs.

id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*string
Min length1

Custom asset type

descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
SubTypestring

Updated record IDs

Total number of records updated