Batch Upsert Companies with HubSpot API

Pipedream makes it easy to connect APIs for HubSpot and 2,800+ other apps remarkably fast.

Trigger workflow on

HTTP requests, schedules and app events

Next, do this

Batch Upsert Companies with the HubSpot API

No credit card required

▶

Watch us build a workflow

8 min

Watch now ➜

Trusted by 1,000,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

Getting Started#

Create a workflow to Batch Upsert Companies with the HubSpot API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Configure the Batch Upsert Companies action
1. Connect your HubSpot account
2. Configure infoAlert
3. Configure Inputs (Companies)
Select a trigger to run your workflow on HTTP requests, schedules or app events
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Integrations#

Batch Upsert Companies with HubSpot API on New Requests (Payload Only) from HTTP / Webhook API

HTTP / Webhook + HubSpot

Try it

Batch Upsert Companies with HubSpot API on New Submission from Typeform API

Typeform + HubSpot

Try it

Batch Upsert Companies with HubSpot API on New Submission (Instant) from Jotform API

Jotform + HubSpot

Try it

Batch Upsert Companies with HubSpot API on New Scheduled Tasks from Pipedream API

Pipedream + HubSpot

Try it

Batch Upsert Companies with HubSpot API on New Download Counts from npm API

npm + HubSpot

Try it

Details#

This is a pre-built, source-available component from Pipedream's GitHub repo. The component is developed by Pipedream and the community, and verified and maintained by Pipedream.

To contribute an update to an existing component or create a new component, create a PR on GitHub. If you're new to Pipedream component development, you can start with quickstarts for trigger span and action development, and then review the component API reference.

Batch Upsert Companies on HubSpot

Description:Upsert a batch of companies in Hubspot. [See the documentation](https://developers.hubspot.com/docs/reference/api/crm/objects/companies#post-%2Fcrm%2Fv3%2Fobjects%2Fcompanies%2Fbatch%2Fupsert)

Version:0.0.1

Key:hubspot-batch-upsert-companies

View on GitHub

Code#

import hubspot from "../../hubspot.app.mjs";
import { API_PATH } from "../../common/constants.mjs";
import { parseObject } from "../../common/utils.mjs";
import { ConfigurationError } from "@pipedream/platform";

export default {
  key: "hubspot-batch-upsert-companies",
  name: "Batch Upsert Companies",
  description: "Upsert a batch of companies in Hubspot. [See the documentation](https://developers.hubspot.com/docs/reference/api/crm/objects/companies#post-%2Fcrm%2Fv3%2Fobjects%2Fcompanies%2Fbatch%2Fupsert)",
  version: "0.0.1",
  type: "action",
  props: {
    hubspot,
    infoAlert: {
      type: "alert",
      alertType: "info",
      content: "Create or update companies identified by a unique property value as specified by the `idProperty` query parameter. `idProperty` query param refers to a property whose values are unique for the object. To manage properties in Hubspot, navigate to your Settings -> Data Management -> Properties.",
    },
    inputs: {
      type: "string[]",
      label: "Inputs (Companies)",
      description: "Provide a **list of companies** to be upserted. [See the documentation](https://developers.hubspot.com/docs/reference/api/crm/objects/companies#post-%2Fcrm%2Fv3%2Fobjects%2Fcompanies%2Fbatch%2Fupsert) for more information. Example: `[ { \"idProperty\": \"unique_property\", \"id\": \"123\", \"properties\": { \"name\": \"CompanyName\" } } ]`",
    },
  },
  methods: {
    batchUpsertCompanies(opts = {}) {
      return this.hubspot.makeRequest({
        api: API_PATH.CRMV3,
        endpoint: "/objects/companies/batch/upsert",
        method: "POST",
        ...opts,
      });
    },
  },
  async run({ $ }) {
    try {
      const response = await this.batchUpsertCompanies({
        $,
        data: {
          inputs: parseObject(this.inputs),
        },
      });
      $.export("$summary", `Upserted ${response.results.length} companies`);
      return response;
    } catch (error) {
      const message = JSON.parse((JSON.parse(error.message).message).split(/:(.+)/)[1])[0].message;
      throw new ConfigurationError(message.split(/:(.+)/)[0]);
    }
  },
};

Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI and CLI.

Label	Prop	Type	Description
HubSpot	`hubspot`	`app`	This component uses the HubSpot app.
Inputs (Companies)	`inputs`	`string[]`	Provide a list of companies to be upserted. See the documentation for more information. Example: `[ { "idProperty": "unique_property", "id": "123", "properties": { "name": "CompanyName" } } ]`

Authentication#

HubSpot uses OAuth authentication. When you connect your HubSpot account, Pipedream will open a popup window where you can sign into HubSpot and grant Pipedream permission to connect to your account. Pipedream securely stores and automatically refreshes the OAuth tokens so you can easily authenticate any HubSpot API.

Pipedream requests the following authorization scopes when you connect your account:

business-intelligencecrm.lists.readcrm.lists.writecrm.objects.companies.readcrm.objects.companies.writecrm.objects.contacts.readcrm.objects.contacts.writecrm.objects.deals.readcrm.objects.deals.writecrm.objects.quotes.readcrm.objects.quotes.writecrm.objects.owners.readcrm.objects.listings.writecrm.objects.listings.readcrm.schemas.companies.readcrm.schemas.companies.writecrm.schemas.contacts.readcrm.schemas.contacts.writecrm.schemas.deals.readcrm.schemas.deals.writecrm.schemas.quotes.readcrm.schemas.listings.writecrm.schemas.listings.readconversations.readcrm.importfilesformsforms-uploaded-filesintegration-syncoauthtimeline