View as Markdown
Yespo icon

Yespo ACTION

Add or Update Contact

Adds a new contact or updates an existing one. See the documentation
  • Action
  • Writes data
  • Destructive
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Yespo account once, then configure and run Add 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: "yespo-add-update-contact",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    yespo: { authProvisionId: "apn_xxxxxxx" },
    firstName: "First Name",
    lastName: "Last 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.

Add or Update Contact inputs
Property Type Description
firstName First Name string
Contact's first name.
Optional
lastName Last Name string
Contact's last name.
Optional
channels Channels string[]
Channels for the contact. For example: [ { "device": { "appId": "83b77a49-fc28-409b-aeaa-68c9d544ab9d", "deviceModel": "iPhone", "os": "iOS", "locale": "en_UK", "clientVersion": "native", "appVersion": "1.23.45", "active": true }, "type": "email", "value": "pipedream@test.com" } ]. See the documentation to further information
Required
addressRegion Region string
The address region.
Optional
addressTown Town string
The address city.
Optional
address Address string
The address line.
Optional
addressPostcode Postcode string
Postal/ZIP code.
Optional
additionalFields Additional Fields object
Values of the additional fields for a contact. Keys are additional field ID.
Optional
addressBookId Address Book Id string
The address book unique identifier.
Optional
contactId Contact Id string
The Id of the contact.
Optional Dynamic
externalCustomerId External Customer Id string
External contact id.
Optional
contactKey Contact Key string
Contact's key.
Optional
languageCode Language Code string
Language code for the contact.
Optional
timeZone TimeZone string
The contact's time zone. See TZ database name.
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
yespo-add-update-contact
Version
0.0.2
App
Yespo
Authentication
API key
Read-only
No
Destructive
Yes
Open world
Yes