View as Markdown
Regal icon

Regal ACTION

Create or Update Contact

Create or update a contacts. See the documentation
  • Action
  • Writes data
  • Destructive
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Regal account once, then configure and run Create or 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: "regal-create-or-update-contact",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    regal: { authProvisionId: "apn_xxxxxxx" },
    userId: "User ID",
    phone: "Phone",
  },
})

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.

Create or Update Contact inputs
Property Type Description
userId User ID string
Unique identifier for your contact
Optional
phone Phone string
Phone number of the contact. Example: +1 (954) 555-2399
Optional
smsOptIn SMS Opt-In boolean
SMS subscription status. Defaults to true
Optional
voiceOptIn Voice Opt-In boolean
Voice subscription status. Defaults to true
Optional
email Email string
Email address of the contact
Optional
emailOptIn Email Opt-In boolean
Email subscription status. Defaults to true
Optional
firstName First Name string
First name of the contact
Optional
lastName Last Name string
Last name of the contact
Optional
streetAddress Street Address string
Street address of the contact
Optional
city City string
City of the contact
Optional
state State string
State/Region of the contact
Optional
zip Zip string
Zip code of the contact
Optional
country Country string
Country of the contact. Example: United States
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
regal-create-or-update-contact
Version
0.0.2
App
Regal
Authentication
API key
Read-only
No
Destructive
Yes
Open world
Yes