View as Markdown
CompanyHub icon

CompanyHub ACTION

Create Company

Creates a new company. See the documentation
  • Action
  • Writes data
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's CompanyHub account once, then configure and run Create Company from your backend or agent.

import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const result = await pd.actions.run({
  id: "companyhub-create-company",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    companyhub: { authProvisionId: "apn_xxxxxxx" },
    name: "Name",
    website: "Website",
  },
})

console.log(result)

SCHEMA

Inputs

Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.

Create Company inputs
Property Type Description
name Name string
The name of the company
Required
website Website string
The website URL of the company
Optional
phone Phone string
The phone number of the company
Optional
description Description string
A description of the company
Optional
billingStreet Billing Street string
The billing street address
Optional
billingCity Billing City string
The billing city
Optional
billingState Billing State string
The billing state/province
Optional
billingCountry Billing Country string
The billing country
Optional
billingPostalCode Billing Postal Code string
The billing postal/zip code
Optional
shippingStreet Shipping Street string
The shipping street address
Optional
shippingCity Shipping City string
The shipping city
Optional
shippingState Shipping State string
The shipping state/province
Optional
shippingCountry Shipping Country string
The shipping country
Optional
shippingPostalCode Shipping Postal Code string
The shipping postal/zip code
Optional

REFERENCE

Tool details

Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.

Registry key
companyhub-create-company
Version
0.0.2
App
CompanyHub
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes