View as Markdown
CompanyHub icon

CompanyHub ACTION

Create Deal

Creates a new deal. 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 Deal 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-deal",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    companyhub: { authProvisionId: "apn_xxxxxxx" },
    name: "Deal Name",
    stage: "Deal Stage",
  },
})

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 Deal inputs
Property Type Description
name Deal Name string
The name of the deal
Required
stage Deal Stage string
The stage of the deal
Required
companyId Company ID string
The ID of the company
Optional Dynamic
contactId Contact ID string
The ID of the contact
Optional Dynamic
amount Amount string
The amount of the deal
Optional
closeDate Expected Close Date string
The expected close date of the deal in ISO-8601 format. E.g. 2025-03-14T00:00:00
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-deal
Version
0.0.2
App
CompanyHub
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes