...
Table of Contents | ||||||
---|---|---|---|---|---|---|
|
Overview
You can use this Snap to delete bulk data objects in the HubSpot portal. For Learn more information about HubSpot APIs, refer to HubSpot Documentation.
Prerequisites
None.
Support for Ultra Pipelines
Works in Ultra Pipelines.
Known Issues and Limitations
None.
Snap Views
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. |
Snap Settings
Info |
---|
|
...
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. Dropdown list | Select the version of the API that you are using for the pipeline. | |
Category* Default Value: N/A | String | Required. Select the application in which you are deleting the data objects from. | ||
Entity* Default Value: N/A | String | Required. Select the data object to be deleted. | ||
Action* Default Value: N/A | 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 | Integer | Required. A time period within which the snap should be runSpecify the connection timeout duration in seconds. | ||
Number of re-triesretries* Default Value: 0 | IInteger | Required. The Specify the maximum number of re-connection attempts reconnections in case of a connection failure or timeout. | ||
Retry interval (seconds)* Default Value: 0 Example: 10 | Integer | Required. The Specify the time interval between consecutive reconnection connection attempts. | ||
Snap Execution Default Value: Execute only | Dropdown list | Select one of the following three modes in which the Snap executes:
|
Examples
Delete a batch of companies
The following example pipeline demonstrates how to use the 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.
...
On validation, you can view the JSON output in the output preview.
...
Configure the Mapper snap to map the output details from the JSON Generator Snap to the corresponding fields in the HubSpot.
...
Validate the Mapper Snap. The JSON input fields are mapped to the HubSpot entity's fields, as shown
...
below:
...
...
Configure the HubSpot Bulk Delete Snap
...
with the
...
Companies Entity and Achieve a Batch of Companies
...
by ID Action.
...
On running the HubSpot Bulk Delete Snap, it deletes the batch of companies as shown in the screenshot below.
...
Downloads
Info |
---|
|
Attachments | ||||
---|---|---|---|---|
|
Snap Pack History
Multiexcerpt include macro | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
|
...
Related Content
Endpoint Doc Link 1
Endpoint Doc Link 2
Endpoint Doc Link 3HubSpot Documentation.
...