View as Markdown
ServiceM8 icon

ServiceM8 ACTION

Update Note

Update a note (loads the record, merges your fields, then POSTs). See the documentation
  • Action
  • Writes data
  • OAuth
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's ServiceM8 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: "servicem8-update-note",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    servicem8: { authProvisionId: "apn_xxxxxxx" },
    uuid: "Note to update",
    relatedObject: "Related Object",
  },
})

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
uuid Note to update string
Note record to load, merge, and save (search or paste UUID).
Required Dynamic
relatedObject Related Object string
Object type this note is attached to; lowercase per API. Pick a type, then choose the record below.
Optional
relatedObjectUuid Related record string
Related record UUID (choose Related object first, then search).
Optional Dynamic
note Note string
Note text and content.
Optional
actionRequired Action Required string
Follow-up text when the note requires an action from someone.
Optional
actionCompletedByStaffUuid Action completed by string
Staff member who completed the required action.
Optional Dynamic

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
servicem8-update-note
Version
0.0.1
App
ServiceM8
Authentication
OAuth
Read-only
No
Destructive
No
Open world
Yes