View as Markdown
SuiteDash icon

SuiteDash ACTION

Update Company

Updates an existing company's details in SuiteDash. See the documentation
  • Action
  • Writes data
  • Destructive
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's SuiteDash 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: "suitedash-update-company",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    suitedash: { authProvisionId: "apn_xxxxxxx" },
    companyId: "Company ID",
    companyName: "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 ID of the company
Required Dynamic
companyName Company Name string
The name of the new company.
Optional
website Website string
The website of the company.
Optional
phone Phone string
The phone number of the company
Optional
companyAddress Company Address string
The full address of the company. Example: dba Staybridge Suites Mount Laurel 324 Church Road Mount Laurel, NJ 09478
Optional
tags Tags string[]
An array of tags associated with the company
Optional
backgroundInfo Background Info string
Background information about the company
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
suitedash-update-company
Version
0.0.2
App
SuiteDash
Authentication
API key
Read-only
No
Destructive
Yes
Open world
Yes