View as Markdown
Salesforce icon

Salesforce ACTION

Update Note

Update a classic Salesforce note (up to 32 KB of plain text). Use Update Content Note instead for enhanced rich-text notes - the two are different objects. Supplying Body replaces the note text outright rather than appending to it. See the documentation
  • Action
  • Writes data
  • OAuth
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Salesforce account once, then configure and run Update Note 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: "salesforce_rest_api-update-note",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    salesforce_rest_api: { authProvisionId: "apn_xxxxxxx" },
    noteId: "Note ID",
    Body: "Body",
  },
})

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 Note inputs
Property Type Description
noteId Note ID string
The ID of the note to update (Salesforce's 15- or 18-character record ID, e.g. 002XX000001aBcD). Use SOQL Query to find the ID.
Required
Body Body string
Body of the note. Limited to 32 KB.
Optional
IsPrivate Private boolean
If true, only the note owner or a user with the "Modify All Data" permission can view the note or query it via the API.
Optional
OwnerId Owner ID string
ID of the user who owns the note (Salesforce's 15- or 18-character record ID, e.g. 005XX000001SvR2). Use SOQL Query to find the User ID.
Optional
ParentId Parent ID string
ID of the object associated with the note. See the documentation for which objects can be referenced.
Optional
Title Title string
Title of the note.
Optional
additionalFields Additional Fields object
Other fields to set for this record as name -> value pairs. Values are parsed as JSON where applicable. Example: {"Industry": "Technology", "AnnualRevenue": 1000000}. Use Describe Object to discover valid field names.
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
salesforce_rest_api-update-note
Version
0.1.1
App
Salesforce
Authentication
OAuth
Read-only
No
Destructive
No
Open world
Yes