View as Markdown
ServiceM8 icon

ServiceM8 ACTION

Update Staff Member

Update a staff member (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 Staff Member 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-staff",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    servicem8: { authProvisionId: "apn_xxxxxxx" },
    uuid: "Staff member to update",
    first: "First 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 Staff Member inputs
Property Type Description
uuid Staff member to update string
Staff record to load, merge, and save (search or paste UUID).
Required Dynamic
first First Name string
First name (max 30 characters).
Required
last Last Name string
Last name (max 30 characters).
Required
email Email string
Email address; also used as login name.
Required
mobile Mobile string
Mobile number for SMS and caller identification.
Optional
jobTitle Job Title string
Role or title shown across the product.
Optional
navigatingToJobUuid Navigating to job string
Job the staff member is currently navigating to.
Optional Dynamic
color Color string
Hex color for schedule and dispatch display.
Optional
customIconUrl Custom Icon URL string
Deprecated in the API.
Optional
statusMessage Status Message string
Short summary of current status.
Optional
hideFromSchedule Hide From Schedule string
0 = visible on schedule; 1 = hidden.
Optional
canReceivePushNotification Can Receive Push Notification string
Whether this staff member can receive push notifications (API string/flag).
Optional
securityRoleUuid Security Role string
Permission set (API security_role_uuid).
Optional Dynamic
labourMaterialUuid Labour Material string
Default labour inventory material (API labour_material_uuid).
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-staff
Version
0.0.1
App
ServiceM8
Authentication
OAuth
Read-only
No
Destructive
No
Open world
Yes