Input 

Document

• Min: 0

• Max: 1

• HubSpot Read

• Mapper

• Copy

A document containing key/identifier of the data object(s) to delete.

Output

Document

• Min: 0

• Max: 1

• Mapper

• Copy

• Email Sender

A document containing the entity ID(s) and the status of the delete operation

Error

Error handling is a generic way to handle errors without losing data or failing the Snap execution. You can handle the errors that the Snap might encounter when running the Pipeline by choosing one of the following options from the When errors occur list under the Views tab:

• Stop Pipeline Execution: Stops the current Pipeline execution if the Snap encounters an error.

• Discard Error Data and Continue: Ignores the error, discards that record, and continues with the remaining records.

• Route Error Data to Error View: Routes the error data to an error view without stopping the Snap execution.

Learn more about Error handling in Pipelines.

Label*

Default Value: HubSpot Bulk Delete

Example: Bulk Delete Companies

String

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.

API Version

Default Value: V3
Example: V4

String/Expression

Required. Select the version of the API that you are using for the pipeline.

Category

Default Value: N/A

Example: CRM

String

Required. Select the application in which you are deleting the data objects from.

Entity

Default Value: N/A

Example: Companies

String

Required. Select the data object to be deleted.

Action

Default Value: N/A

Example: Archive a batch of companies by ID

String

Required. Select the action to be performed by the snap. Clicking the icon lists the supported actions.

Required parameters

Use this field set to enable the Snap to perform a specific action.

Parameter

Default Value: N/A Example: company.id

String

Required. Specify the names of the required parameters. Clicking the icon lists the supported actions.

Value

Default Value: N/A Example: company.id

Multiple

Required. Specify the values for mentioned parameters. The data type of this field depends on the specified parameter

Connection timeout

Default Value: 30

Example: 30

Integer

Required. A time period within which the snap should be run.

Number of re-tries

Default Value: 0

Example: 3

IInteger

Required. The maximum number of re-connection attempts in case of a failure or timeout.

Retry interval (seconds)

Default Value: 0

Example: 10

Integer

Required. The time interval between consecutive reconnection attempts.

Snap Execution

Default Value: Execute only
Example: Validate & Execute

Dropdown list

Select one of the following three modes in which the Snap executes:

• 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.