View as Markdown
Nutshell icon

Nutshell ACTION

Update Company

Update an existing company (account) in Nutshell. See the documentation
  • Action
  • Writes data
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Nutshell account once, then configure and run Update 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: "nutshell-update-company",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    nutshell: { authProvisionId: "apn_xxxxxxx" },
    companyId: "Company ID",
    name: "Company Name",
  },
})

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.

Update Company inputs
Property Type Description
companyId Company ID string
The company (account) ID.
Required Dynamic
name Company Name string
Updated company name.
Optional
industryId Industry ID string
The industry the company belongs to.
Optional Dynamic
accountTypeId Account Type ID string
The account type of the company.
Optional Dynamic
territoryId Territory ID string
The territory of the company.
Optional Dynamic
address Address string[]
Array of address objects as JSON strings, e.g. {"name":"HQ","address_1":"123 Main St","city":"Austin"}. Each object must include a name label (required on update).
Optional
email Email string[]
Array of email objects as JSON strings, e.g. {"isPrimary":true,"name":"work","value":"info@acme.com"}. Each object must include a name label (required on update).
Optional
phone Phone string[]
Array of phone objects as JSON strings, e.g. {"isPrimary":true,"name":"main","value":"+15125551234"}. Each object must include a name label (required on update).
Optional
url URLs string[]
Array of URL objects as JSON strings, e.g. {"name":"website","value":"https://acme.com"}. Each object must include a name label (required on update).
Optional
customFields Custom Fields object
Custom field name->value pairs, e.g. {"Customer tier":"Gold"}.
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
nutshell-update-company
Version
1.0.1
App
Nutshell
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes