View as Markdown
Heyy icon

Heyy ACTION

Create Contact

Creates a new contact for the business. See the documentation.
  • Action
  • Writes data
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Heyy account once, then configure and run Create 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: "heyy-create-contact",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    heyy: { authProvisionId: "apn_xxxxxxx" },
    phoneNumber: "Phone Number",
    firstName: "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.

Create Contact inputs
Property Type Description
phoneNumber Phone Number string
The phone number of the contact. It must be in E.164 format. Eg: +14155552671. For more information please see here.
Required
firstName First Name string
The first name of the contact.
Required
lastName Last Name string
The last name of the contact.
Optional
email Email string
The email address of the contact.
Optional
labels Labels string[]
The labels associated with the contact.
Optional Dynamic
attributes Attributes object
The attributes associated with the contact.
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
heyy-create-contact
Version
0.0.2
App
Heyy
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes