View as Markdown
Nutshell icon

Nutshell ACTION

Update Contact

Update an existing contact (person) 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 Contact 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-contact",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    nutshell: { authProvisionId: "apn_xxxxxxx" },
    contactId: "Contact ID",
    name: "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 Contact inputs
Property Type Description
contactId Contact ID string
The contact ID.
Required Dynamic
name Name string
The contact's updated full name, e.g. Jane Doe.
Optional
email Email string[]
Array of email objects as JSON strings, e.g. {"isPrimary":true,"name":"work","value":"jane@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":"mobile","value":"+15125551234"}. Each object must include a name label (required on update).
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-contact
Version
1.0.1
App
Nutshell
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes