In this article
| Table of Contents | ||||
|---|---|---|---|---|
|
Overview
Use this Snap to update the details of an entity in 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 details identifying the entity to update along with the information to update. |
| Output | Document |
|
| A document containing details of the updated entity. |
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 update. | Association | Company | ||||||||
| Action | String | Required. Select the update-action to perform on the entity selected above. Click  to see the list of supported actions. | N/A | Update 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=1605167250446&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
Updating a Company in HubSpot
We want to update a company entity in the HubSpot instance. This Pipeline demonstrates how we can use the HubSpot Update Snap to accomplish this task:
First, we use the JSON Generator Snap to create a JSON file containing the entity's updated details such as country, founded_year, and address. It is not necessary to use a JSON input, we can also use CSV (CSV Generator) and XML (XML Generator). Alternatively, we can use a File Reader Snap if we already have a file with the company's details and configure it to read the company details file.
The screenshot below shows the output from the JSON Generator Snap:
We map the fields from the output shown above to the corresponding fields in HubSpot using the Mapper Snap.
Upon execution, the JSON input file's fields are mapped to the HubSpot entity's fields as shown in the Mapper Snap's output below:
The above output is passed to the HubSpot Update Snap. The HubSpot Update Snap is configured with the Company entity and Update a company action.
Upon execution, the HubSpot Update Snap updates the company with the specified details as shown in the HubSpot Update Snap's output below:
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 Update Snap. The screenshot below shows the configuration of the File Writer Snap:
Downloads
| Note | ||
|---|---|---|
| ||
|
| Attachments | ||
|---|---|---|
|
| Insert excerpt | ||||||
|---|---|---|---|---|---|---|
|
...