Salesforce Delete

Overview

The Salesforce Delete Snap enables you to delete records using REST API or Bulk API 1.0.

The Snap in Bulk API mode submits a batch job and writes the batch job information to the output view, which should be passed to the Salesforce Poller Snap to check the result of the batch job. The Snap in REST API mode deletes records and returns results synchronously without the need of the Salesforce Poller Snap. This Snap executes a soft delete.

Note: To use newer Salesforce objects, use the latest API versions where those objects are available.


Supported Accounts

Limitations

  • All expression fields can support Pipeline parameters only when they are expression-enabled. The input data parameters are not supported for expression fields, for example, $serviceVersion.

Snap views

Type Description Examples of upstream and downstream Snaps
Input

This Snap has exactly one input view and receives documents in the view.

Each document contains an ID of the record to be deleted.

Output

This Snap has at most one output view and produces documents in the view.

Each document contains Map data that includes the Job ID, Batch ID, URL, and an array of records in Bulk API mode. If it is executed in REST API mode, each document contains Map data for the ID of the deleted record and a key-value pair of "created":"false".

Learn more about Error handling.

Snap settings

Legend:
  • Expression icon (): Allows using pipeline parameters to set field values dynamically (if enabled). SnapLogic Expressions are not supported. If disabled, you can provide a static value.
  • SnapGPT (): Generates SnapLogic Expressions based on natural language using SnapGPT. Learn more.
  • Suggestion icon (): Populates a list of values dynamically based on your Snap configuration. You can select only one attribute at a time using the icon. Type into the field if it supports a comma-separated list of values.
  • Upload : Uploads files. Learn more.
Learn more about the icons in the Snap settings dialog.
Field/Field set Description
Label

String

Required. Specify the name for the Snap. You can modify this to be more specific, especially if you have more than one of the same Snap in your Pipeline.

Default value: Salesforce Delete

Service Version

String/Expression/ Suggestion

Required. Specify the version number associated with the Salesforce service that you want to connect to. Alternatively, click the Suggestion icon to fetch the list of versions and select the desired version.

Default value: 52.0

Example: 41.0

Batch Size

String/Expression

In Bulk API, this property value is allowed to be from 1 through 10,000. Each input document can contain an ID value to delete one Salesforce record. The Snap stores input records in memory until the number of records reaches the batch size and sends the request to SFDC in a single batch. Increasing the batch size increases the amount of memory used. Decreasing the batch size increases the number of API calls against Salesforce.

In REST API, the Snap can delete only one record per request regardless of the value of the Batch size property.

Default value: 200

Example: 10000

Object Type

String/Expression/ Suggestion

Specify the name of the Salesforce object or select one from the suggested list.

Note: This Snap does not support Net Zero Cloud Salesforce objects.

Default value: Account

Example: Account

Salesforce API

Dropdown list

Required. Set the Salesforce API mode to Bulk API or REST API. The Snap in REST API mode deletes one record at a time and returns the results at the output. REST API can be simpler and faster if the number of records to be created is small (a few).

Default value: Bulk API

Example: REST API

Bulk API Serial mode

Checkbox

Select this checkbox to enable the serial mode for Bulk API. Else, the Bulk API runs in parallel mode.

Default value: Deselected (Parallel mode)

Standardize Error Output

Checkbox

Select this checkbox to enable the Snap to produce the error output with Reason, Original, Stack trace and Resolution. If deselected, the output view will simply show the input document along with the error message.

Default value: Deselected

Pass Through

Checkbox

Select this checkbox to pass the input document to the output view under the key original. This field applies to REST API and Bulk API, but only when the batch size is one.

Note: For Bulk APIs, if you select this check box and if the Batch size is equal to 1, the input document is passed to the output view under the key original. If the Batch size is greater than 1, the list of input documents is displayed under Records and the input document is not included under the original key.

Default value: Selected

Snap execution

Dropdown list
Choose one of the three modes in which the Snap executes. Available options are:
  • Validate & Execute. Performs limited execution of the Snap and generates a data preview during pipeline validation. Subsequently, performs full execution of the Snap (unlimited records) during pipeline runtime.
  • Execute only. Performs full execution of the Snap during pipeline execution without generating preview data.
  • Disabled. Disables the Snap and all Snaps that are downstream from it.
Note: If you want to get the resulting status for each record to be deleted in Bulk API mode, you must connect a Salesforce Poller Snap after the Salesforce Delete Snap.