Skip to content

Salesforce Connector ReferenceΒΆ

The following operations allow you to work with the Salesforce Connector. Click an operation name to see parameter details and sample usage.

Note: The API version is configurable and can be adjusted based on your Salesforce environment or requirements. This version of the Salesforce Connector was tested using Salesforce API version v60.0.


Initialize the connectorΒΆ

The WSO2 Integrator: MI Salesforce connector offers two connection types, each suited to a different API family:

Connection type Typical use-case Provide What the connector does
OAuth 2.0 REST & Bulk APIs Client Credentials grant**
β€’ clientId
β€’ clientSecret
Access-token only: uses it until it expires, then fails.

Client Credentials: automatically exchanges clientId + clientSecret for a fresh access token whenever needed.
BasicAuth (SOAP login) SOAP Partner/Enterprise APIs (query, create, update, etc.) β€’ username
β€’ password
Calls the Salesforce SOAP login operation, retrieves a session ID, and attaches it to every subsequent SOAP request.

Note: BasicAuth is only for SOAP operations. REST and Bulk calls must use OAuth 2.0. For more information on how authentication is done in Salesforce, see Understanding Authentication.

OAuth 2.0

This connection initializes the connector to interact with the Salesforce REST & Bulk APIs. See the related API documentation for more information.

Parameter Name Description Required Sample Value
connectionName A logical name to identify this connection. Yes SALESFORCE_OAUTH_2
scope Space-separated OAuth scopes. No full refresh_token
clientId Consumer Key from your connected app. Yes XXXXXXXXXXXX
clientSecret Consumer Secret from your connected app. Yes XXXXXXXXXXXX
tokenUrl OAuth 2.0 token endpoint URL. Yes https://login.salesforce.com/services/oauth2/token
instanceUrl Base URL for API requests. Yes https://your_instance.salesforce.com
apiVersion Salesforce API version. No v60.0
timeout Connection timeout in milliseconds. No 3000
blocking Enable blocking API calls. No false

Sample configuration

<salesforcerest.init>
    <connectionName>{${payload.connectionName}}</connectionName>
    <grantType>{${payload.grantType}}</grantType>
    <scope>{${payload.scope}}</scope>
    <clientId>{${payload.clientId}}</clientId>
    <clientSecret>{${payload.clientSecret}}</clientSecret>
    <tokenUrl>{${payload.tokenUrl}}</tokenUrl>
    <instanceUrl>{${payload.instanceUrl}}</instanceUrl>
    <apiVersion>{${payload.apiVersion}}</apiVersion>
    <timeout>{${payload.timeout}}</timeout>
    <blocking>{${payload.blocking}}</blocking>
</salesforcerest.init>

Sample request

{
  "connectionName": "SALESFORCE_OAUTH_2",
  "scope": "full refresh_token",
  "clientId": "XXXXXXXXXXXX",
  "clientSecret": "XXXXXXXXXXXX",
  "tokenUrl": "https://login.salesforce.com/services/oauth2/token",
  "instanceUrl": "https://your_instance.salesforce.com",
  "apiVersion": "v60.0",
  "timeout": "3000",
  "readTimeout": "3000",
  "blocking": "false"
}
BasicAuth

This connection also initializes the connector to interact with Salesforce via Basic Authentication using the SOAP login API. See the SOAP API Developer Guide for more information.

Parameter Name Description Required Sample Value
connectionName A logical name to identify this connection. Yes BasicAuth
username Salesforce login username. Yes [email protected]
password Password followed by your security token. Yes MyP@ssw0rdXyZ
loginUrl Salesforce login endpoint URL. Yes https://login.salesforce.com/services/Soap/u/60.0
forceLogin Always start a new session if enabled. No false
blocking Enable blocking API calls to Salesforce. No false

**Sample configuration**

```xml
<salesforcerest.init>
    <connectionName>{${payload.connectionName}}</connectionName>
    <username>{${payload.username}}</username>
    <password>{${payload.password}}</password>
    <loginUrl>{${payload.loginUrl}}</loginUrl>
    <forceLogin>{${payload.forceLogin}}</forceLogin>
    <blocking>{${payload.blocking}}</blocking>
</salesforcerest.init>
```

**Sample request**

```json
{
    "connectionName": "BasicAuth",
    "username": "[email protected]",
    "password": "MyP@ssw0rdXyZ",
    "loginUrl": "https://login.salesforce.com/services/Soap/u/60.0",
    "forceLogin": "false",
    "blocking": "false"
}
```
search

The salesforce.search operation allows you to search for records by specifying a search string. See the related API documentation for more information.

Parameter Name Description Required Sample Value
searchString The SOQL query to execute the search. Yes sample string

Sample configuration

<salesforce.search>
    <searchString>{${payload.searchString}}</searchString>
</salesforce.search>

Sample request

{
    "searchString": "FIND {map*} IN ALL FIELDS RETURNING Account (Id, Name), Contact, Opportunity, Lead",
}

UsersΒΆ

getUserInformation

The salesforce.getUserInformation operation retrieves information about a specific user by specifying the following property. See the related API documentation for more information.

Parameter Name Description Required Sample Value
userId The ID of the user whose details you want to retrieve. Yes 00528000000yl7j

Sample configuration

<salesforce.getUserInformation>
    <userId>{${payload.userId}}</userId>
</salesforce.getUserInformation>

Sample request

{
    "userId": "00528000000yl7j"
}
resetPassword

The salesforce.resetPassword operation resets a specific user’s password by specifying the following property. See the related API documentation for more information.

Parameter Name Description Required Sample Value
userId The ID of the user whose password you want to reset. Yes 00528000000yl7j

**Sample configuration**

```xml
<salesforce.resetPassword>
    <userId>{${payload.userId}}</userId>
</salesforce.resetPassword>
```

**Sample request**

```json
{
    "userId": "00528000000yl7j",
}
```
setPassword

The salesforce.setPassword operation sets a specific user’s password by specifying the following properties. See the related API documentation for more information.

Parameter Name Description Required Sample Value
userId The ID of the user whose password you want to set. Yes 00528000000yl7j
fieldAndValue JSON object containing the new password field and its value β€” for example: {"NewPassword":"MyNewP@ssw0rd"} Yes {"NewPassword":"MyNewP@ssw0rd"}

Sample configuration

<salesforce.setPassword>
    <userId>{${payload.userId}}</userId>
    <fieldAndValue>{${payload.fieldAndValue}}</fieldAndValue>
</salesforce.setPassword>

Sample request

{
    "userId": "00528000000yl7j",
    "fieldAndValue": "{\"NewPassword\":\"MyNewP@ssw0rd\"}"
}

QueryΒΆ

query

The salesforce.query operation retrieves data from a Salesforce object by specifying the following properties. To include deleted records in the Recycle Bin, use the salesforce.queryAll operation in place of salesforce.query. See the related API documentation for more information.

Parameter Name Description Required Sample Value
queryString The SQL query to use to search for records. Yes select id, name from Account
queryAll Check if the deleted records should be included in the result false

Sample configuration

query:

<salesforce.query>
    <queryString>{${payload.queryString}}</queryString>
</salesforce.query>

queryAll:

<salesforce.queryAll>
    <queryString>{${payload.queryString}}</queryString>
</salesforce.queryAll>

Sample request

{
    "queryString": "SELECT ID, NAME FROM ACCOUNT",
}

RecordsΒΆ

create

The salesforce.create operation creates a new record by specifying the following properties. See the related API documentation for more information.

Parameter Name Description Required Sample Value
sObjectName The type of object for which you will create a record. Yes Account
fieldAndValue The .json format property used to create the record. Include all mandatory fields according to the requirements for the specified sObject. Yes
{
        "name": "wso2",
        "description":"This Account belongs to WSO2"}
        

Sample configuration

<salesforce.create>
    <sObjectName>{${payload.sObjectName}}</sObjectName>
    <fieldAndValue>{${payload.fieldAndValue}}</fieldAndValue>
</salesforce.create>

Sample request

The following is a sample request that can be handled by the create operation.

{
    "sObjectName":"Account",,
    "fieldAndValue": {
        "name": "wso2",
        "description":"This Account belongs to WSO2"
    }
}
createBulk

The salesforce.createBulk operation creates multiple records of the same sObject type by specifying the following properties. See the related API documentation for more information.

Parameter Name Description Required Sample Value
sObjectName The type of object for which you will create a record. Yes Account
fieldAndValue The .json format property, which specifies each record as an entry within the records array. Include all mandatory fields according to the requirements for the specified sObject. Yes
{
        "records": [
        {
        "attributes": {"type": "Account", "referenceId": "ref1"},
        "name": "wso2",
        "phone": "1111111",
        "website": "www.salesforce1.com"
        },
        {
        "attributes": {"type": "Account", "referenceId": "ref2"},
        "name": "slwso2",
        "phone": "22222222",
        "website": "www.salesforce2.com"
        }]
        }
        

Note: For example, if you are creating a record for the Account sObject, "name" is a mandatory parameter, and you might want to include the optional description, so the fieldAndValue property would look like this:

{
  "records": [
  {
       "attributes": {"type": "Account", "referenceId": "ref1"},
       "name": "wso2",
       "phone": "1111111",
       "website": "www.salesforce1.com"
   },
   {
       "attributes": {"type": "Account", "referenceId": "ref2"},
       "name": "slwso2",
       "phone": "22222222",
       "website": "www.salesforce2.com"
   }]
}

Sample configuration

<salesforce.createBulk>
    <sObjectName>{${payload.sObjectName}}</sObjectName>
    <fieldAndValue>{${payload.fieldAndValue}}</fieldAndValue>
</salesforce.createBulk>

Sample request

{
    "sObjectName":"Account",,
    "fieldAndValue": {
        "records": [
            {
            "attributes": {"type": "Account", "referenceId": "ref1"},
            "name": "wso2",
            "phone": "1111111",
            "website": "www.salesforce1.com"
            },
            {
            "attributes": {"type": "Account", "referenceId": "ref2"},
            "name": "slwso2",
            "phone": "22222222",
            "website": "www.salesforce2.com"
            }]
        }
}
createTree

To create nested records for a specific sObject, use salesforce.createTree and specify the following properties. See the related API documentation for more information.

Parameter Name Description Required Sample Value
sObjectName The type of object for which you will create a record. Yes
fieldAndValue The .json format property, which specifies each record as an entry within the records array. Include all mandatory fields according to the requirements for the specified sobject. Yes
{
        "records" :[{
        "attributes" : {"type" : "Account", "referenceId" : "ref1"},
        "name" : "SampleAccount1",
        "phone" : "1234567890",
        "website" : "www.salesforce.com",
        "numberOfEmployees" : "100",
        "type" : "Analyst",
        "industry" : "Banking",
        "Contacts" : {
        "records" : [{
        "attributes" : {"type" : "Contact", "referenceId" : "ref2"},
        "lastname" : "Smith",
        "Title" : "President",
        "email" : "[email protected]"
        },{
        "attributes" : {"type" : "Account", "referenceId" : "ref3"},
        "lastname" : "Evans",
        "title" : "Vice President",
        "email" : "[email protected]"
        }]
        }
        },{
        "attributes" : {"type" : "Account", "referenceId" : "ref4"},
        "name" : "SampleAccount2",
        "phone" : "1234567890",
        "website" : "www.salesforce.com",
        "numberOfEmployees" : "52000",
        "type" : "Analyst",
        "industry" : "Banking",
        "childAccounts" : {
        "records" : [{
        "attributes" : {"type" : "Account", "referenceId" : "ref5"},
        "name" : "SampleChildAccount1",
        "phone" : "1234567890",
        "website" : "www.salesforce.com",
        "numberOfEmployees" : "100",
        "type" : "Analyst",
        "industry" : "Banking"
        }]
        },
        "Contacts" : {
        "records" : [{
        "attributes" : {"type" : "Contact", "referenceId" : "ref6"},
        "lastname" : "Jones",
        "title" : "President",
        "email" : "[email protected]"
        }]
        }
        }]
        }
        

Note: If you are creating records for the Account sObject, "name" is a mandatory parameter, and you might want to include additional optional values for each record, so the fieldAndValue property might look like this:

{
  "records" :[{
  "attributes" : {"type" : "Account", "referenceId" : "ref1"},
  "name" : "SampleAccount1",
  "phone" : "1234567890",
  "website" : "www.salesforce.com",
  "numberOfEmployees" : "100",
  "type" : "Analyst",
  "industry" : "Banking",
  "Contacts" : {
    "records" : [{
      "attributes" : {"type" : "Contact", "referenceId" : "ref2"},
      "lastname" : "Smith",
      "Title" : "President",
      "email" : "[email protected]"
    },{
      "attributes" : {"type" : "Contact", "referenceId" : "ref3"},
      "lastname" : "Evans",
      "title" : "Vice President",
      "email" : "[email protected]"
    }]
  }
  },{
  "attributes" : {"type" : "Account", "referenceId" : "ref4"},
  "name" : "SampleAccount2",
  "phone" : "1234567890",
  "website" : "www.salesforce.com",
  "numberOfEmployees" : "52000",
  "type" : "Analyst",
  "industry" : "Banking",
  "childAccounts" : {
    "records" : [{
      "attributes" : {"type" : "Account", "referenceId" : "ref5"},
      "name" : "SampleChildAccount1",
      "phone" : "1234567890",
      "website" : "www.salesforce.com",
      "numberOfEmployees" : "100",
      "type" : "Analyst",
      "industry" : "Banking"
    }]
  },
  "Contacts" : {
    "records" : [{
      "attributes" : {"type" : "Contact", "referenceId" : "ref6"},
      "lastname" : "Jones",
      "title" : "President",
      "email" : "[email protected]"
    }]
  }
  }]
}

Sample configuration

<salesforce.createTree>
    <sObjectName>{${payload.sObjectName}}</sobject>
    <fieldAndValue>{${payload.fieldAndValue}}</fieldAndValue>
</salesforce.createTree>

Sample request

{
    "sObjectName": "Account",
    "fieldAndValue": {
        "records": [
            {
                "attributes": {
                    "type": "Account",
                    "referenceId": "ref1"
                },
                "name": "SampleAccount1",
                "phone": "1234567890",
                "website": "www.salesforce.com",
                "numberOfEmployees": "100",
                "type": "Analyst",
                "industry": "Banking",
                "Contacts": {
                    "records": [
                        {
                            "attributes": {
                                "type": "Contact",
                                "referenceId": "ref2"
                            },
                            "LastName": "Smith",
                            "Title": "President",
                            "Email": "[email protected]"
                        },
                        {
                            "attributes": {
                                "type": "Contact",
                                "referenceId": "ref3"
                            }, // fixed
                            "LastName": "Evans", // fixed
                            "Title": "Vice President", // fixed
                            "Email": "[email protected]" // fixed
                        }
                    ]
                }
            },
            {
                "attributes": {
                    "type": "Account",
                    "referenceId": "ref4"
                },
                "name": "SampleAccount2",
                "phone": "1234567890",
                "website": "www.salesforce.com",
                "numberOfEmployees": "52000",
                "type": "Analyst",
                "industry": "Banking",
                "childAccounts": {
                    "records": [
                        {
                            "attributes": {
                                "type": "Account",
                                "referenceId": "ref5"
                            },
                            "name": "SampleChildAccount1",
                            "phone": "1234567890",
                            "website": "www.salesforce.com",
                            "numberOfEmployees": "100",
                            "type": "Analyst",
                            "industry": "Banking"
                        }
                    ]
                },
                "Contacts": {
                    "records": [
                        {
                            "attributes": {
                                "type": "Contact",
                                "referenceId": "ref6"
                            },
                            "LastName": "Jones",
                            "Title": "President",
                            "Email": "[email protected]"
                        }
                    ]
                }
            }
        ]
    }
}
update

The salesforce.update operation updates an existing record by specifying the following properties. See the related API documentation for more information.

Parameter Name Description Required Sample Value
sObjectName The type of object for which you will create a record. Yes Account
fieldAndValue The json format property with the new definition for the record. Yes
{
        "name": "wso2",
        "description":"This Account belongs to WSO2"
        }
        
Id The ID of the record you are updating. Yes 00128000002OOhD

Sample configuration

<salesforce.update>
    <sObjectName>{${payload.sObjectName}}</sObjectName>
    <fieldAndValue>{${payload.fieldAndValue}}</fieldAndValue>
    <Id>{${payload.Id}}</Id>
</salesforce.update>

Sample request

{
    "sObjectName":"Account",
    "Id":"00128000002OOhD",,
    "fieldAndValue": {
        "name": "wso2",
        "description":"This Account belongs to WSO2"
    }
}
delete

The salesforce.delete operation deletes a record and requires the following properties. See the related API documentation for more information.

Parameter Name Description Required Sample Value
sObjectName The object type of the record. Yes Account
Id The ID of the record you are deleting. Yes 00128000002OOhD

Sample configuration

<salesforce.update>
    <sObjectName>{${payload.sObjectName}}</sObjectName>
    <fieldAndValue>{${payload.fieldAndValue}}</fieldAndValue>
    <Id>{$ctx:Id}</Id>
</salesforce.update>

Sample request

{
    "sObjectName":"Account",
    "idToDelete":"00128000002OOhD",
}
upsert

The salesforce.upsert operation creates or updates a record using an external ID by specifying the following properties. This method is used to create records or update existing records based on the value of a specified external ID field. See the related API documentation for more information.

Parameter Name Description Required Sample Value
sObjectName The object type whose value you want to upsert. Yes Account
externalIDField The external Id Field of the subject. Yes sample__c
Id The value of the customExtIdField. Yes 15222
fieldAndValue The json format property/payload used to create the record. Yes { "Name":"john" }

Sample configuration

<salesforce.upsert>
    <sObjectName>{${payload.sObjectName}}</sObjectName>
    <externalIDField>{${payload.externalIDField}}</externalIDField>
    <Id>{${payload.Id}}</Id>
    <fieldAndValue>{${payload.fieldAndValue}}</fieldAndValue>
</salesforce.upsert>

Sample request

{
    "sObjectName":"Account",,
    "intervalTime" : "2400000",
    "externalIDField":"sample__c",
    "Id":"15222",
    "fieldAndValue":
    {
        "Name":"john"
    }
}
getDeleted

The salesforce.getDeleted operation retrieves a list of records deleted within a specified timespan for the given object. Provide the start and end date-time values in ISO 8601 format: YYYY-MM-DDThh:mm:ss+hh:mm. See the related API documentation for more information.

Parameter Name Description Required Sample Value
sObjectName The object where you want to look for deleted records Yes Account
startTime Starting date/time (Coordinated Universal Time (UTC)β€”not localβ€”timezone) of the timespan for which to retrieve the data. Yes 2015-10-05T12:30:30+05:30
endTime Ending date/time (Coordinated Universal Time (UTC)β€”not localβ€”timezone) of the timespan for which to retrieve the data. Yes 2015-10-10T20:30:30+05:30

Sample configuration

<salesforce.getDeleted>
    <sObjectName>{${payload.sObjectName}}</sObjectName>
    <startTime>{${payload.startTime}}</startTime>
    <endTime>{${payload.endTime}}</endTime>
</salesforce.getDeleted>

Sample request

{
  "sObjectName":"Account",
  "startTime":"2015-10-05T12:30:30+05:30",
  "endTime":"2015-10-10T20:30:30+05:30"
}
getUpdated

The salesforce.getUpdated operation retrieves a list of records updated within a specified timespan for the given object. Provide the start and end date-time values in ISO 8601 format: YYYY-MM-DDThh:mm:ss+hh:mm. See the related API documentation for more information.

Parameter Name Description Required Sample Value
sObjectName The object where you want to look for updated records Yes Account
startTime Starting date/time (Coordinated Universal Time (UTC)β€”not localβ€”timezone) of the timespan for which to retrieve the data. Yes 2015-10-05T12:30:30+05:30
endTime Ending date/time (Coordinated Universal Time (UTC)β€”not localβ€”timezone) of the timespan for which to retrieve the data. Yes 2015-10-10T20:30:30+05:30

Sample configuration

<salesforce.getUpdated>
    <sObjectName>{${payload.sObjectName}}</sObjectName>
    <startTime>{${payload.startTime}}</startTime>
    <endTime>{${payload.endTime}}</endTime>
</salesforce.getUpdated>

Sample request

{
    "sObjectName":"Account",
    "startTime":"2015-10-05T12:30:30+05:30",
    "endTime":"2015-10-10T20:30:30+05:30"
}

sObjectsΒΆ

describeGlobal

The salesforce.describeGlobal operation retrieves a list of all objects available in the system. You can then obtain metadata for one or more objects as described in the following sections. See the related API documentation for more information.

Sample configuration

<salesforce.describeGlobal/>

Sample request

{}
describeSObject

The salesforce.describeSObject operation retrieves metadata (such as name, label, and fieldsβ€”including field properties) for a specific object type by specifying the following properties. See the related API documentation for more information.

Parameter Name Description Required Sample Value
sObjectName The object type whose metadata you want to retrieve. Yes Account

Sample configuration

<salesforce.describeSObject>
    <sObjectName>{${payload.sObjectName}}</sObjectName>
</salesforce.describeSObject>

Sample request

{
    "sObjectName":"Account",
}
retrieveSObject

The salesforce.retrieveSObject operation retrieves details of a specific record. See the related API documentation for more information.

Parameter Name Description Required Sample Value
sObjectName The object type of the record. Yes Account
rowId The ID of the record whose details you want to retrieve. Yes 00128000005YjDnAAK

Sample configuration

<salesforce.retrieveSObject>
    <sObjectName>{${payload.sObjectName}}</sObjectName>
    <rowId>{${payload.rowId}}</rowId>
</salesforce.retrieveSObject>

Sample request

{
    "sObjectName":"Account",
    "rowId":"00128000005YjDnAAK",
}

CompositeΒΆ

compositeBatch

The salesforce.compositeBatch operation executes up to 25 sub-requests in a single call to Salesforce’s Composite Batch REST resource. See the related API documentation for more information.

Parameter Name Description Required Sample Value
Field and Value JSON string that defines the array of sub-requests (each sub-request includes method, url, optional body, and a referenceId). Yes [{"method":"GET","url":"/services/data/v60.0/sobjects/Account/001..."}]

Sample configuration

<salesforce.compositeBatch>
    <fieldAndValue>{${payload.fieldAndValue}}</fieldAndValue>
</salesforce.compositeBatch>

Sample request

{
    "fieldAndValue": {
        "batchRequests": [
            {
                "method": "PATCH",
                "url": "v64.0/sobjects/account/001D000000K0fXOIAZ",
                "richInput": {
                    "Name": "NewName"
                }
            },
            {
                "method": "GET",
                "url": "v64.0/sobjects/account/001D000000K0fXOIAZ?fields=Name,BillingPostalCode"
            }
        ]
    }
}
compositeGraph

The salesforce.compositeGraph operation submits one or more composite graph operations to Salesforce’s Composite Graph REST resource. Each graph can contain multiple sub-requests that are executed in the order you define. See the Composite Graph API documentation for full details.

Parameter Name Description Required Sample Value
Field and Value A JSON object that defines one or more graphs.
Each graph contains a graphId and a compositeRequest array.
Every sub-request in compositeRequest specifies method, url, an optional body, and a referenceId.
Yes { "graphs": [ { "graphId": "Graph1", "compositeRequest": [ … ] } ] }

Sample configuration

<salesforce.compositeGraph>
    <fieldAndValue>{${payload.fieldAndValue}}</fieldAndValue>
</salesforce.compositeGraph>

Sample request

{
    "fieldAndValue": {
        "graphs": [
            {
                "graphId": "Graph1",
                "compositeRequest": [
                    {
                        "method": "GET",
                        "url": "/services/data/v60.0/sobjects/Account/0018g00000XXXXXAAA",
                        "referenceId": "RefAccount"
                    },
                    {
                        "method": "PATCH",
                        "url": "/services/data/v60.0/sobjects/Account/@{RefAccount.Id}",
                        "body": {
                            "Industry": "Manufacturing"
                        },
                        "referenceId": "UpdateAccount"
                    }
                ]
            }
        ]
    }
}
compositeRequest

The salesforce.compositeRequest operation executes a series of REST API sub-requests in a single call to Salesforce’s Composite REST resource, preserving the order and allowing inter-request references. See the Composite API documentation for full details.

Parameter Name Description Required Sample Value
Field And Value A JSON object that defines the composite request.
Must include an allOrNone flag and a compositeRequest array.
Each item in compositeRequest specifies method, url, an optional body, and a referenceId.
Yes { "allOrNone": true, "compositeRequest": [ … ] }

Sample configuration

<salesforce.compositeRequest>
    <fieldAndValue>{${payload.fieldAndValue}}</fieldAndValue>
</salesforce.compositeRequest>

Sample request

{
    "fieldAndValue": {
        "allOrNone": true,
        "compositeRequest": [
            {
                "method": "GET",
                "url": "/services/data/v60.0/sobjects/Account/0018g00000XXXXXAAA",
                "referenceId": "RefAccount"
            },
            {
                "method": "PATCH",
                "url": "/services/data/v60.0/sobjects/Account/@{RefAccount.id}",
                "body": {
                    "Industry": "Manufacturing"
                },
                "referenceId": "UpdateAccount"
            },
            {
                "method": "POST",
                "url": "/services/data/v60.0/sobjects/Contact",
                "body": {
                    "LastName": "Smith",
                    "AccountId": "@{RefAccount.id}"
                },
                "referenceId": "CreateContact"
            }
        ]
    }
}

Bulk V2ΒΆ

abortJob

The salesforce.abortJob operation aborts a bulk ingest job in Salesforce using Salesforce Bulk API v2. See the related API documentation for more information.

Parameter Name Description Required Sample Value
Salesforce configuration The Salesforce configuration that stores OAuth-related data. Yes salesforceConfig
Job ID The bulk job ID. Yes 7503i000000XXXXXAAI

Sample configuration

<salesforce.abortJob>
    <jobId>{${payload.jobId}}</jobId>
</salesforce.abortJob>

Sample request

{
    "jobId": "7503i000000XXXXXAAI"
}
createJob

The salesforce.createJob operation creates a bulk ingest job in Salesforce using Salesforce Bulk API v2. See the related API documentation for more information.

Parameter Name Description Required Sample Value
Salesforce configuration The Salesforce configuration that stores OAuth-related data. Yes salesforceConfig
Operation The bulk operation to perform on the data (for example, insert, update, upsert, or delete). Yes insert
Object The object type for the data being processed. Use only a single object type per job. Yes Account
Column Delimeter The column delimiter used for CSV job data. Default is COMMA. Valid values: BACKQUOTE, CARET, COMMA, PIPE, SEMICOLON, TAB. Yes COMMA
Line Ending The line ending used for CSV job data, marking the end of a data row. Valid values: LF, CRLF. Default is LF. Yes LF
Assignment Rule ID The ID of an assignment rule to run for a Case or a Lead. The rule can be active or inactive. No 01Q3j000000XXXXAAA
External ID Field Name The external-ID field in the object being updated. Required only for upsert operations. No External_Id__c

Sample configuration

<salesforce.createJob>
    <operation>{${payload.operation}}</operation>
    <object>{${payload.object}}</object>
    <columnDelimiter>{${payload.columnDelimiter}}</columnDelimiter>
    <lineEnding>{${payload.lineEnding}}</lineEnding>
    <assignmentRuleId>{${payload.assignmentRuleId}}</assignmentRuleId>
    <externalIdFieldName>{${payload.externalIdFieldName}}</externalIdFieldName>
</salesforce.createJob>

Sample request

{
    "operation": "insert",
    "object": "Account",
    "columnDelimiter": "COMMA",
    "lineEnding": "LF",
    "assignmentRuleId": "01Q3j000000XXXXAAA",
    "externalIdFieldName": "External_Id__c"
}
closeJob

The salesforce.closeJob operation closes a bulk ingest job in Salesforce using Salesforce Bulk API v2. See the related API documentation for more information.

Parameter Name Description Required Sample Value
Salesforce configuration The Salesforce configuration that stores OAuth-related data. Yes salesforceConfig
Job ID The bulk job ID. Yes 7503i000000XXXXXAAI

Sample configuration

<salesforce.closeJob>
    <jobId>{${payload.jobId}}</jobId>
</salesforce.closeJob>

Sample request

{
    "jobId": "7503i000000XXXXXAAI"
}
deleteJob

The salesforce.deleteJob operation deletes a bulk ingest job in Salesforce using Salesforce Bulk API v2. See the related API documentation for more information.

Parameter Name Description Required Sample Value
Salesforce configuration The Salesforce configuration that stores OAuth-related data. Yes salesforceConfig
Job ID The bulk job ID. Yes 7503i000000XXXXXAAI

Sample configuration

<salesforce.deleteJob>
    <jobId>{${payload.jobId}}</jobId>
</salesforce.deleteJob>

Sample request

{
    "jobId": "7503i000000XXXXXAAI"
}
getAllJobInfo

The salesforce.getJobInfo operation retrieve all the bulk ingest job information from Salesforce using Salesforce Bulk API v2. See the related API documentation for more information.

Parameter Name Description Required Sample Value
Salesforce configuration The Salesforce configuration that stores OAuth-related data. Yes salesforceConfig
IsPKChunkingEnabled If set to true, returns information only about jobs where PK Chunking is enabled (Bulk API 1.0 only). No true
Job Type Returns jobs that match the specified type.
Valid values: Classic, BigObjectIngest, V2Ingest, All.
No V2Ingest
Query Locator Returns jobs starting at the specified locator value. No 0Sf3i0000004oBAEAY

Sample configuration

<salesforce.getAllJobInfo>
    <isPKChunkingEnabled>{${payload.isPKChunkingEnabled}}</isPKChunkingEnabled>
    <jobType>{${payload.jobType}}</jobType>
    <queryLocator>{${payload.queryLocator}}</queryLocator>
</salesforce.getAllJobInfo>

Sample request

{
    "isPKChunkingEnabled": true,
    "jobType": "V2Ingest",
    "queryLocator": "0Sf3i0000004oBAEAY"
}
getFailedResults

The salesforce.getFailedResults operation retrieves failed records of a specific bulk job from Salesforce using the Salesforce Bulk API v2. See the related API documentation for more information.

Parameter Name Description Required Sample Value
Salesforce configuration The Salesforce configuration that stores OAuth-related data. Yes salesforceConfig
Job ID The bulk job ID. Yes 7503i000000XXXXXAAI
Output Type The response content type. Yes CSV
Add Results To Where to store the results (FILE or BODY). Yes FILE
File Path The file path to store results (required only when Add Results To is FILE). If FILE selected /tmp/failed_results.csv

Sample configuration

<salesforce.getFailedResults>
    <jobId>{${payload.jobId}}</jobId>
    <outputType>{${payload.outputType}}</outputType>
    <addResultsTo>{${payload.addResultsTo}}</addResultsTo>
    <filePath>{${payload.filePath}}</filePath>
</salesforce.getFailedResults>

Sample request

{
    "jobId": "7503i000000XXXXXAAI",
    "outputType": "CSV",
    "addResultsTo": "FILE",
    "filePath": "/tmp/failed_results.csv"
}
getJobInfo

The salesforce.getJobInfo operation retrieve bulk ingest job information from Salesforce using Salesforce Bulk API v2. See the related API documentation for more information.

Parameter Name Description Required Sample Value
Salesforce configuration The Salesforce configuration that stores OAuth-related data. Yes salesforceConfig
Job ID The bulk job ID. Yes 7503i000000XXXXXAAI

Sample configuration

<salesforce.getJobInfo>
    <jobId>{${payload.jobId}}</jobId>
</salesforce.getJobInfo>

Sample request

{
    "jobId": "7503i000000XXXXXAAI"
}
getSuccessfulResults

The salesforce.getSuccessfulResults operation retrieves successful records of a specific bulk job from Salesforce using the Salesforce Bulk API v2. See the related API documentation for more information.

Parameter Name Description Required Sample Value
Salesforce configuration The Salesforce configuration that stores OAuth-related data. Yes salesforceConfig
Job ID The bulk job ID. Yes 7503i000000XXXXXAAI
Output Type The response content type. Yes CSV
Add Results To Where to store the results (FILE or BODY). Yes FILE
File Path The file path to store results (required only when Add Results To is FILE). If FILE selected /tmp/success_results.csv

Sample configuration

<salesforce.getSuccessfulResults>
    <jobId>{${payload.jobId}}</jobId>
    <outputType>{${payload.outputType}}</outputType>
    <addResultsTo>{${payload.addResultsTo}}</addResultsTo>
    <filePath>{${payload.filePath}}</filePath>
</salesforce.getSuccessfulResults>

Sample request

{
    "jobId": "7503i000000XXXXXAAI",
    "outputType": "CSV",
    "addResultsTo": "FILE",
    "filePath": "/tmp/success_results.csv"
}
getUnprocessedResults

The salesforce.getUnprocessedResults operation retrieves unprocessed records of a specific bulk job from Salesforce using the Salesforce Bulk API v2. See the related API documentation for more information.

Parameter Name Description Required Sample Value
Salesforce configuration The Salesforce configuration that stores OAuth-related data. Yes salesforceConfig
Job ID The bulk job ID. Yes 7503i000000XXXXXAAI
Output Type The response content type. Yes CSV
Add Results To Where to store the results (FILE or BODY). Yes FILE
File Path The file path to store results (required only when Add Results To is FILE). If FILE selected /tmp/unprocessed_results.csv

Sample configuration

<salesforce.getUnprocessedResults>
    <jobId>{${payload.jobId}}</jobId>
    <outputType>{${payload.outputType}}</outputType>
    <addResultsTo>{${payload.addResultsTo}}</addResultsTo>
    <filePath>{${payload.filePath}}</filePath>
</salesforce.getUnprocessedResults>

Sample request

{
    "jobId": "7503i000000XXXXXAAI",
    "outputType": "CSV",
    "addResultsTo": "FILE",
    "filePath": "/tmp/unprocessed_results.csv"
}
uploadJobData

The salesforce.uploadJobData operation upload the csv records to a bulk job in Salesforce using the Salesforce Bulk API v2. See the related API documentation for more information.

Parameter Name Description Required Sample Value
Salesforce configuration The Salesforce configuration that stores OAuth-related data. Yes salesforceConfig
Job ID The bulk job ID. Yes 7503i000000XXXXXAAI
Input Data The CSV content to upload. Yes Name,Industry Acme,Manufacturing

Sample configuration

<salesforce.uploadJobData>
    <jobId>{${payload.jobId}}</jobId>
    <inputData>{${payload.inputData}}</inputData>
</salesforce.uploadJobData>

Sample request

{
    "jobId": "7503i000000XXXXXAAI",
    "inputData": "Name,Industry\nAcme,Manufacturing"
}
createQueryJob

The salesforce.createQueryJob operation creates a bulk query job in Salesforce using Salesforce Bulk API v2. See the related API documentation for more information.

Parameter Name Description Required Sample Value
Salesforce configuration The Salesforce configuration that stores OAuth-related data. Yes salesforceConfig
Operation The type of query.
Valid values: QUERY, QUERY_ALL.
Yes QUERY
Column Delimiter The column delimiter used for CSV job data.
Default is COMMA.
Valid values: BACKQUOTE, CARET, COMMA, PIPE, SEMICOLON, TAB.
Yes COMMA
Line Ending The line ending used for CSV job data, marking the end of a data row.
Valid values: LF, CRLF.
Default is LF.
Yes LF

Sample configuration

<salesforce.createQueryJob>
    <operation>{${payload.operation}}</operation>
    <columnDelimiter>{${payload.columnDelimiter}}</columnDelimiter>
    <lineEnding>{${payload.lineEnding}}</lineEnding>
</salesforce.createQueryJob>

Sample request

{
    "operation": "QUERY",
    "columnDelimiter": "COMMA",
    "lineEnding": "LF"
}
abortQueryJob

The salesforce.abortQueryJob operation aborts a bulk query job in Salesforce using Salesforce Bulk API v2. See the related API documentation for more information.

Parameter Name Description Required Sample Value
Salesforce configuration The Salesforce configuration that stores OAuth-related data. Yes salesforceConfig
Query Job ID The bulk query job ID. Yes 7508i000000YYYYAAA

Sample configuration

<salesforce.abortQueryJob>
    <queryJobId>{${payload.queryJobId}}</queryJobId>
</salesforce.abortQueryJob>

Sample request

{
    "queryJobId": "7508i000000YYYYAAA"
}
deleteQueryJob

The salesforce.deleteQueryJob operation deletes a bulk query job in Salesforce using Salesforce Bulk API v2. See the related API documentation for more information.

Parameter Name Description Required Sample Value
Salesforce configuration The Salesforce configuration that stores OAuth-related data. Yes salesforceConfig
Query Job ID The bulk query job ID. Yes 7508i000000YYYYAAA

Sample configuration

<salesforce.deleteQueryJob>
    <queryJobId>{${payload.queryJobId}}</queryJobId>
</salesforce.deleteQueryJob>

Sample request

{
    "queryJobId": "7508i000000YYYYAAA"
}
getQueryJobInfo

The salesforce.getQueryJobInfo operation retrieve bulk query job information from Salesforce using Salesforce Bulk API v2. See the related API documentation for more information.

Parameter Name Description Required Sample Value
Salesforce configuration The Salesforce configuration that stores OAuth-related data. Yes salesforceConfig
Job ID The bulk query job ID. Yes 7508i000000YYYYAAA

Sample configuration

<salesforce.getQueryJobInfo>
    <jobId>{${payload.jobId}}</jobId>
</salesforce.getQueryJobInfo>

Sample request

{
    "jobId": "7508i000000YYYYAAA"
}
getAllQueryJobInfo

The salesforce.getAllQueryJobInfo operation retrieve all the bulk query job information from Salesforce using Salesforce Bulk API v2. See the related API documentation for more information.

Parameter Name Description Required Sample Value
Salesforce configuration The Salesforce configuration that stores OAuth-related data. Yes salesforceConfig
IsPKChunkingEnabled If set to true, returns information only about jobs where PK Chunking is enabled (Bulk API 1.0 only). No true
Job Type Returns jobs that match the specified type.
Valid values: Classic, V2Query, V2Ingest, All.
No V2Query
Query Locator Returns jobs starting at the specified locator value. No 0Sf3i0000004oBAEAY

Sample configuration

<salesforce.getAllQueryJobInfo>
    <isPKChunkingEnabled>{${payload.isPKChunkingEnabled}}</isPKChunkingEnabled>
    <jobType>{${payload.jobType}}</jobType>
    <queryLocator>{${payload.queryLocator}}</queryLocator>
</salesforce.getAllQueryJobInfo>

Sample request

{
    "isPKChunkingEnabled": true,
    "jobType": "V2Query",
    "queryLocator": "0Sf3i0000004oBAEAY"
}
getQueryJobResults

The salesforce.getQueryJobResults operation retrieves the results of a specified bulk query job from Salesforce using the Salesforce Bulk API v2. See the related API documentation for more information.

Parameter Name Description Required Sample Value
Salesforce configuration The Salesforce configuration that stores OAuth-related data. Yes salesforceConfig
Job ID The ID of the bulk query job. Yes 7508i000000YYYYAAA
Locator A string that identifies a specific set of query results. Providing a value returns only that set of results. No 02X8i000004abcdEAA
Max Records The maximum number of records to retrieve per result set. No 500
Output Type The response content type. Yes CSV
Add Results To Where to store the results (FILE or BODY). Yes FILE
File Path The file path to store results (required only when Add Results To is FILE). If FILE selected /tmp/query_results.csv

Sample configuration

<salesforce.getQueryJobResults>
    <jobId>{${payload.jobId}}</jobId>
    <locator>{${payload.locator}}</locator>
    <maxRecords>{${payload.maxRecords}}</maxRecords>
    <outputType>{${payload.outputType}}</outputType>
    <addResultsTo>{${payload.addResultsTo}}</addResultsTo>
    <filePath>{${payload.filePath}}</filePath>
</salesforce.getQueryJobResults>

Sample request

{
    "jobId": "7508i000000YYYYAAA",
    "locator": "02X8i000004abcdEAA",
    "maxRecords": 500,
    "outputType": "CSV",
    "addResultsTo": "FILE",
    "filePath": "/tmp/query_results.csv"
}

SOAPΒΆ

soapConvertLead

The salesforce.soapConvertLead operation converts one or more Lead records into Account, Contact, and (optionally) Opportunity records. See the SOAP API documentation for more information.

Parameter Name Description Required Sample Value
Lead Convert Requests The convert lead requests Yes [{...}]

Sample configuration

<salesforce.soapConvertLead>
    <leadconvertrequests>{${payload.leadconvertrequests}}</leadconvertrequests>
</salesforce.soapConvertLead>

Sample request

{
  "leadconvertrequests": "[{...}]"
}
soapCreate

The salesforce.soapCreate operation adds one or more new records to Salesforce. See the SOAP API documentation for more information.

Parameter Name Description Required Sample Value
All or None Whether to rollback changes if an object fails(Default value is 0). Yes 1
Allow Field Truncate Whether to truncates strings that exceed the field length(Default value is 0). Yes 1
sObjects The sobject type Yes Account

Sample configuration

<salesforce.soapCreate>
    <allOrNone>{${payload.allOrNone}}</allOrNone>
    <allowFieldTruncate>{${payload.allowFieldTruncate}}</allowFieldTruncate>
    <sobjects>{${payload.sobjects}}</sobjects>
</salesforce.soapCreate>

Sample request

{
  "allOrNone": "1",
  "allowFieldTruncate": "1",
  "sobjects": "Account"
}
soapDelete

The salesforce.soapDelete operation deletes one or more records from Salesforce. See the SOAP API documentation for more information.

Parameter Name Description Required Sample Value
All or None Whether to rollback changes if an object fails(Default value is 0). Yes 1
sObjects The sobject type Yes Account

Sample configuration

<salesforce.soapDelete>
    <allOrNone>{${payload.allOrNone}}</allOrNone>
    <sobjects>{${payload.sobjects}}</sobjects>
</salesforce.soapDelete>

Sample request

{
  "allOrNone": "1",
  "sobjects": "Account"
}
soapDescribeGlobal

The salesforce.soapDescribeGlobal operation retrieves a list of all objects available in your organization's data. See the SOAP API documentation for more information.

Parameter Name Description Required Sample Value
No parameters

Sample configuration

<salesforce.soapDescribeGlobal>
</salesforce.soapDescribeGlobal>

Sample request

{}
soapDescribeSObject

The salesforce.soapDescribeSObject operation describes metadata (fields and properties) for the specified object. See the SOAP API documentation for more information.

Parameter Name Description Required Sample Value
sObject The sobject type Yes Account

Sample configuration

<salesforce.soapDescribeSObject>
    <sobject>{${payload.sobject}}</sobject>
</salesforce.soapDescribeSObject>

Sample request

{
  "sobject": "Account"
}
soapDescribeSObjects

The salesforce.soapDescribeSObjects operation describes metadata (fields and properties) for one or more specified objects. See the SOAP API documentation for more information.

Parameter Name Description Required Sample Value
sObjects The sobject types Yes Account

Sample configuration

<salesforce.soapDescribeSObjects>
    <sobjects>{${payload.sobjects}}</sobjects>
</salesforce.soapDescribeSObjects>

Sample request

{
  "sobjects": "Account"
}
soapEmptyRecycleBin

The salesforce.soapEmptyRecycleBin operation permanently deletes records from the Recycle Bin. See the SOAP API documentation for more information.

Parameter Name Description Required Sample Value
All or None Whether to rollback changes if an object fails(Default value is 0). Yes 1
sObjects The sobject type Yes Account

Sample configuration

<salesforce.soapEmptyRecycleBin>
    <allOrNone>{${payload.allOrNone}}</allOrNone>
    <sobjects>{${payload.sobjects}}</sobjects>
</salesforce.soapEmptyRecycleBin>

Sample request

{
  "allOrNone": "1",
  "sobjects": "Account"
}
soapFindDuplicates

The salesforce.soapFindDuplicates operation searches for duplicate records based on defined matching rules. See the SOAP API documentation for more information.

Parameter Name Description Required Sample Value
sObjects The sobject type Yes Account

Sample configuration

<salesforce.soapFindDuplicates>
    <sobjects>{${payload.sobjects}}</sobjects>
</salesforce.soapFindDuplicates>

Sample request

{
  "sobjects": "Account"
}
soapFindDuplicatesByIds

The salesforce.soapFindDuplicatesByIds operation searches for duplicate records for the provided record IDs. See the SOAP API documentation for more information. The input is an array of IDs.

Parameter Name Description Required Sample Value
IDs Record ids Yes ["0018g00000XXXXXAAA"]

Sample configuration

<salesforce.soapFindDuplicatesByIds>
    <ids>{${payload.ids}}</ids>
</salesforce.soapFindDuplicatesByIds>

Sample request

{
  "ids": "[\"0018g00000XXXXXAAA\"]"
}
soapGetDeleted

The salesforce.soapGetDeleted operation retrieves IDs of records deleted during a specified time window. See the SOAP API documentation for more information.

Parameter Name Description Required Sample Value
sObject Type The sobject type Yes Account
Start Date The start date for deleted records lookup Yes 2025-06-01T00:00:00Z
End Date The end date for deleted records lookup Yes 2025-06-16T00:00:00Z

Sample configuration

<salesforce.soapGetDeleted>
    <sObjectType>{${payload.sObjectType}}</sObjectType>
    <startDate>{${payload.startDate}}</startDate>
    <endDate>{${payload.endDate}}</endDate>
</salesforce.soapGetDeleted>

Sample request

{
  "sObjectType": "Account",
  "startDate": "2025-06-01T00:00:00Z",
  "endDate": "2025-06-16T00:00:00Z"
}
soapGetServerTimestamp

The salesforce.soapGetServerTimestamp operation retrieves the current server timestamp (UTC). See the SOAP API documentation for more information..

Parameter Name Description Required Sample Value
No parameters

Sample configuration

<salesforce.soapGetServerTimestamp>
</salesforce.soapGetServerTimestamp>

Sample request

{}
soapGetUpdated

The salesforce.soapGetUpdated operation retrieves IDs of records updated during a specified time window. See the SOAP API documentation for more information.

Parameter Name Description Required Sample Value
sObject Type The sobject type Yes Account
Start Date The start date for deleted records lookup Yes 2024-01-01T00:00:00Z
End Date The end date for deleted records lookup Yes 2024-01-02T00:00:00Z

Sample configuration

<salesforce.soapGetUpdated>
    <sObjectType>{${payload.sObjectType}}</sObjectType>
    <startDate>{${payload.startDate}}</startDate>
    <endDate>{${payload.endDate}}</endDate>
</salesforce.soapGetUpdated>

Sample request

{
  "sObjectType": "Account",
  "startDate": "2024-01-01T00:00:00Z",
  "endDate": "2024-01-02T00:00:00Z"
}
soapGetUserInfo

The salesforce.soapGetUserInfo operation retrieves personal information for the user of the current session. See the SOAP API documentation for more information.

Parameter Name Description Required Sample Value
No parameters

Sample configuration

<salesforce.soapGetUserInfo>
</salesforce.soapGetUserInfo>

Sample request

{}
soapLogout

The salesforce.soapLogout operation terminates the current session. See the SOAP API documentation for more information.

Parameter Name Description Required Sample Value
No parameters

Sample configuration

<salesforce.soapLogout>
</salesforce.soapLogout>

Sample request

{}
soapMerge

The salesforce.soapMerge operation merges up to three records of the same object type into a single record. See the SOAP API documentation for more information.

Parameter Name Description Required Sample Value
Merge Requests WThe merge requests. Yes [<MergeRequest/>]

Sample configuration

<salesforce.soapMerge>
    <mergerequests>{${payload.mergerequests}}</mergerequests>
</salesforce.soapMerge>

Sample request

{
  "mergerequests": "[<MergeRequest/>]"
}
soapQuery

The salesforce.soapQuery operation runs a SOQL query and returns matching records. See the SOAP API documentation for more information.

Parameter Name Description Required Sample Value
Batch Size The number of records to return. Yes 200
Query String The queryString to get the results from API. Yes SELECT Id, Name FROM Account

Sample configuration

<salesforce.soapQuery>
    <batchSize>{${payload.batchSize}}</batchSize>
    <queryString>{${payload.queryString}}</queryString>
</salesforce.soapQuery>

Sample request

{
  "batchSize": 200,
  "queryString": "SELECT Id, Name FROM Account"
}
soapQueryAll

The salesforce.soapQueryAll operation runs a SOQL query that returns both active and archived/deleted records. See the SOAP API documentation for more information.

Parameter Name Description Required Sample Value
Batch Size The number of records to return. Yes 200
Query String The queryString to get the results from API. Yes SELECT Id, Name FROM Account

Sample configuration

<salesforce.soapQueryAll>
    <batchSize>{${payload.batchSize}}</batchSize>
    <queryString>{${payload.queryString}}</queryString>
</salesforce.soapQueryAll>

Sample request

{
  "batchSize": 200,
  "queryString": "SELECT Id, Name FROM Account"
}
soapQueryMore

The salesforce.soapQueryMore operation retrieves the next batch of query results. See the SOAP API documentation for more information.

Parameter Name Description Required Sample Value
Batch Size The number of records to return. Yes 200

Sample configuration

<salesforce.soapQueryMore>
    <batchSize>{${payload.batchSize}}</batchSize>
</salesforce.soapQueryMore>

Sample request

{
  "batchSize": 200
}
soapResetPassword

The salesforce.soapResetPassword operation resets a user's password and emails them the new password. See the SOAP API documentation for more information.

Parameter Name Description Required Sample Value
User ID The user's Salesforce ID. Yes 0058g00000XXXXXAAA

Sample configuration

<salesforce.soapResetPassword>
    <userId>{${payload.userId}}</userId>
</salesforce.soapResetPassword>

Sample request

{
  "userId": "0058g00000XXXXXAAA"
}
soapRetrieve

The salesforce.soapRetrieve operation retrieves field values for one or more records of a specified object. See the SOAP API documentation for more information.

Parameter Name Description Required Sample Value
Object Type The object type of the records. Yes Account
Object IDs XML representation of the records to retrieve, as shown in the following example. Yes <ids>001...</ids>
Field List A comma-separated list of the fields you want to retrieve from the records. Yes SampleValue

Sample configuration

<salesforce.soapRetrieve>
    <objectType>{${payload.objectType}}</objectType>
    <objectIDS>{${payload.objectIDS}}</objectIDS>
    <fieldList>{${payload.fieldList}}</fieldList>
</salesforce.soapRetrieve>

Sample request

{
  "objectType": "Account",
  "objectIDS": "<ids>001...</ids>",
  "fieldList": "SampleValue"
}
soapSearch

The salesforce.soapSearch operation executes a SOSL text search against your organization's data. See the SOAP API documentation for more information.

Parameter Name Description Required Sample Value
search String The searchString to get the Result. Yes John

Sample configuration

<salesforce.soapSearch>
    <searchString>{${payload.searchString}}</searchString>
</salesforce.soapSearch>

Sample request

{
    "searchString": "*John*"
}
soapSendEmail

The salesforce.soapSendEmail operation sends a single or mass email immediately. See the SOAP API documentation for more information.

Parameter Name Description Required Sample Value
Send Email XML representation of the email, as shown in the example. Yes {}

Sample configuration

    <salesforce.soapSendEmail>
        <sendEmail>{${payload.sendEmail}}</sendEmail>
    </salesforce.soapSendEmail>

Sample request

    {
      "sendEmail": "<SingleEmailMessage>...</SingleEmailMessage>"
    }
soapSendEmailMessage

The salesforce.soapSendEmailMessage operation sends up to 10 draft EmailMessage records. See the SOAP API documentation for more information.

Parameter Name Description Required Sample Value
Send Email Message XML representation of the email IDs to send, as shown in the example. Yes {}

Sample configuration

    <salesforce.soapSendEmailMessage>
        <sendEmailMessage>{${payload.sendEmailMessage}}</sendEmailMessage>
    </salesforce.soapSendEmailMessage>

Sample request

    {
      "sendEmailMessage": "<EmailMessage>...</EmailMessage>"
    }
soapSetPassword

The salesforce.soapSetPassword operation sets a user's password to a specified value. See the SOAP API documentation for more information.

Parameter Name Description Required Sample Value
User ID The user's Salesforce ID. Yes 0058g00000XXXXXAAA
Password If using setPassword, the new password to assign to the user. Yes P@ssw0rd123

Sample configuration

    <salesforce.soapSetPassword>
        <userId>{${payload.userId}}</userId>
        <password>{${payload.password}}</password>
    </salesforce.soapSetPassword>

Sample request

    {
      "userId": "0058g00000XXXXXAAA",
      "password": "P@ssw0rd123"
    }
soapUndelete

The salesforce.soapUndelete operation restores deleted records from the Recycle Bin. See the SOAP API documentation for more information.

Parameter Name Description Required Sample Value
All or None Whether to rollback changes if an object fails(Default value is 0). Yes 1
sObjects The sobject type Yes Account

Sample configuration

    <salesforce.soapUndelete>
        <allOrNone>{${payload.allOrNone}}</allOrNone>
        <sobjects>{${payload.sobjects}}</sobjects>
    </salesforce.soapUndelete>

Sample request

    {
      "allOrNone": "1",
      "sobjects": "Account"
    }
soapUpdate

The salesforce.soapUpdate operation updates one or more existing records. See the SOAP API documentation for more information.

Parameter Name Description Required Sample Value
All or None Whether to rollback changes if an object fails(Default value is 0). Yes 1
Allow Field Truncate Whether to truncates strings that exceed the field length(Default value is 0). Yes 1
sObjects The sobject type Yes Account

Sample configuration

    <salesforce.soapUpdate>
        <allOrNone>{${payload.allOrNone}}</allOrNone>
        <allowFieldTruncate>{${payload.allowFieldTruncate}}</allowFieldTruncate>
        <sobjects>{${payload.sobjects}}</sobjects>
    </salesforce.soapUpdate>

Sample request

    {
      "allOrNone": "1",
      "allowFieldTruncate": "1",
      "sobjects": "Account"
    }
soapUpsert

The salesforce.soapUpsert operation creates new records or updates existing records based on an external ID field. See the SOAP API documentation for more information.

Parameter Name Description Required Sample Value
All or None Whether to rollback changes if an object fails(Default value is 0). Yes 1
Allow Field Truncate Whether to truncates strings that exceed the field length(Default value is 0). Yes 1
sObjects The sobject type Yes Account
External ID The field containing the record ID Yes External_Id__c

Sample configuration

    <salesforce.soapUpsert>
        <allOrNone>{${payload.allOrNone}}</allOrNone>
        <allowFieldTruncate>{${payload.allowFieldTruncate}}</allowFieldTruncate>
        <sobjects>{${payload.sobjects}}</sobjects>
        <externalId>{${payload.externalId}}</externalId>
    </salesforce.soapUpsert>

Sample request

    {
      "allOrNone": "1",
      "allowFieldTruncate": "1",
      "sobjects": "Account",
      "externalId": "External_Id__c"
    }