In this article

The page's title should always be the Snap's name.  For example, File Reader. 

Overview

Use this Snap to update the details of an entity in the HubSpot instance.

Provide a functional overview of the Snap. Do not mention anything about the Snap's internal technology or techniques. The user should be able to understand what the Snap. Include a screenshot of a well-configured Snap 600px.  

Prerequisites

None.

Support for Ultra Pipelines

Works in Ultra Pipelines. 

Limitations

None.

List all Snap-specific limitations as a bullet list. Limitations can be imposed by the Snap's development environment and also by the endpoint's API. List both. Use direct sentences. Include links to external official documentation, if required. Use "None.: if there are no limitations.  

Known Issues

None.

Snap Input and Output

Type of view: Document/Binary/Both. Get number of views from the Views tab in the Snap. List at least three compatible Snaps in each category. Provide a brief of the input/output required. If the input/output is optional then preface the description with "Optional." For example, "Transaction data complying with the Orderful schema as a JSON document."

Input/OutputType of ViewNumber of ViewsExamples of Upstream and Downstream SnapsDescription
Input 

Document

  • Min: 1
  • Max: 1
  • HubSpot Read
  • Mapper
  • Copy
A document containing details identifying the entity to update along with the information to update.
Output

Document

  • Min: 0
  • Max: 1
  • JSON Formatter + File Writer
  • Mapper
  • Copy
  • HubSpot Read

A document containing details of the updated entity.

Snap Settings


Parameter NameData TypeDescriptionDefault ValueExample 
LabelString
HubSpot CreateCreate a Company
EntityStringRequired. Select the data object to update.AssociationCompany
ActionStringRequired. Select the update-action to perform on the entity selected above. Click  to see the list of supported actions. N/AUpdate a company
Required parameter

Specify the required fields for a specific action. Specify each parameter in a separate row. Click  to add a new row.

This fieldset consists of the following fields: 

  • Parameter
  • Value

Parameter

StringSpecify the names of the required parameters. Click  to see the list of supported parameters.N/A

table_id

ValueMultipleSpecify the values of the required parameters. The data type of this field depends on the specified parameter.N/A

123561234

Connection timeoutIntegerRequired. Enter the connection timeout duration of seconds.3030
Number of retriesIntegerRequired. Enter the maximum number of re-connection attempts in case of a failure or timeout.03
Retry interval (seconds)IntegerRequired. Enter the interval in seconds between reconnections attempts.010
Snap ExecutionString

Indicates how the Snap must be executed. Available options are:

  • Validate & Execute: Performs limited execution of the Snap (up to 50 records) during Pipeline validation; performs full execution of the Snap (unlimited records) during Pipeline execution.
  • Execute only: Performs full execution of the Snap during Pipeline execution; does not execute the Snap during Pipeline validation.

  • Disabled: Disables the Snap and, by extension, its downstream Snaps.

Execute onlyValidate & Execute

Troubleshooting

ErrorReasonResolution

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:

Download this pipeline from the Downloads section.

Downloads

  1. Download and import the Pipeline into SnapLogic.
  2. Configure Snap accounts as applicable.
  3. Provide Pipeline parameters as applicable.



Edit the Excerpt Include macro below to link to the Snap Pack page for this Snap page. Ensure that the heading Snap Pack History is not within the Snap Pack's history Excerpt. 

See Also

Provide links to the endpoint's official documentation, any relevant or related internal documentation, and any other links you have referred to on this page. Care should be taken when referencing external sites/documentation that it is an official site/documentation. Do not refer to forums such as stackoverflow.