In this article
| Table of Contents | ||||
|---|---|---|---|---|
|
Overview
Use this Snap to delete entities from the HubSpot instance.
Prerequisites
None.
Support for Ultra Pipelines
Works in Ultra Pipelines.
Limitations
None.
Known Issues
None.
Snap Input and Output
| Input/Output | Type of View | Number of Views | Examples of Upstream and Downstream Snaps | Description |
|---|---|---|---|---|
| Input | Document |
|
| A document containing key/identifier of the data object to delete. |
| Output | Document |
|
| A document containing the entity ID and the status of the delete operation. |
Snap Settings
| Parameter Name | Data Type | Description | Default Value | Example | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Label | String |
| HubSpot Create | Create a Company | ||||||||
| Entity | String | Required. Select the data object to delete. | Association | Company | ||||||||
| Action | String | Required. Select the delete-action to perform on the entity selected above. Click  to see the list of supported actions. | N/A | Delete a company | ||||||||
| Required parameter | Specify the required fields for a specific action. Specify each parameter in a separate row. Click This fieldset consists of the following fields:
| |||||||||||
Parameter | String | Specify the names of the required parameters. Click to see the list of supported parameters. | N/A | table_id | ||||||||
| Value | Multiple | Specify the values of the required parameters. The data type of this field depends on the specified parameter. | N/A | 123561234 | ||||||||
| Connection timeout | Integer | Required. Enter the connection timeout duration of seconds. | 30 | 30 | ||||||||
| Number of retries | Integer | Required. Enter the maximum number of re-connection attempts in case of a failure or timeout. | 0 | 3 | ||||||||
| Retry interval (seconds) | Integer | Required. Enter the interval in seconds between reconnections attempts. | 0 | 10 | ||||||||
| Snap Execution | String | Indicates how the Snap must be executed. Available options are:
| Execute only | Validate & Execute | ||||||||
.png?version=1&modificationDate=1605168815098&cacheVersion=1&api=v2&width=20){kind=small}
Troubleshooting
| Error | Reason | Resolution |
|---|---|---|
Missing required parameters. | There is a required parameter that was not provided. | Verify whether all required parameters are configured. |
Examples
Deleting a Company from HubSpot
We want to delete a company from the HubSpot instance. This Pipeline demonstrates how we can use the HubSpot Delete Snap to accomplish this task:
| Note |
|---|
We do not need any Snap other than the HubSpot Delete Snap to delete an entity. However, we want to write the delete confirmation output by the HubSpot Delete Snap into a local JSON file. That is why we use the JSON Formatter and File Writer Snap in this example. If there are multiple entities to delete, we can pass the entities' identifier through upstream Snaps or as a Pipeline parameter. In that case, we can add Snaps such as Mapper, File Reader, or Copy, upstream of the HubSpot Delete Snap. |
We configure the HubSpot Delete Snap with the Company entity and Delete a company action. We also provide the entity's identifier (company_id) as a required parameter.
Upon execution, the HubSpot Delete Snap deletes the specified entity and outputs a confirmation of the same.
Since we want to write this output into a local file for record-keeping, we use a combination of the JSON Formatter and File Writer Snaps downstream of the HubSpot Delete Snap. The screenshot below shows the configuration of the File Writer Snap:
Downloads
| Note | ||
|---|---|---|
| ||
|
| Attachments | ||
|---|---|---|
|
| Insert excerpt | ||||||
|---|---|---|---|---|---|---|
|
...