...
Table of Contents | ||||||
---|---|---|---|---|---|---|
|
Overview
Using this snap, you can You can use this Snap to delete bulk data objects in the HubSpot portal. For more information about HubSpot APIs, see refer to HubSpot Documentation.
Prerequisites
...
Type | Format | Number of Views | Examples of Upstream and Downstream Snaps | Description |
---|---|---|---|---|
Input | Document |
|
| A document containing key/identifier of the data object(s) to delete. |
Output | Document |
|
| 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:
Learn more about Error handling in Pipelines. |
...
Field Name | Field Type | Description | |
---|---|---|---|
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 | 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 | |
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 | Dropdown list | Select one of the following three modes in which the Snap executes:
|
...
The pipeline in this example demonstrates the use of HubSpot Bulk Delete snap to delete the batch of companies in the HubSpot portal.
Download this pipeline.
In this Pipeline,
Configure the JSON Generator Snap to provide the company name as input to delete the specific companies. The screenshot below shows the output from the JSON Generator Snap:
...