View as Markdown
CATS icon

CATS ACTION

Create Contact

Adds a new contact to the CATS platform. See the documentation
  • Action
  • Writes data
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's CATS 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: "cats-create-contact",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    cats: { 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.

Create Contact inputs
Property Type Description
firstName First Name string
The first name of the record.
Required
lastName Last Name string
The last name of the record.
Required
ownerId Owner ID integer
The user id of the record owner.
Required Dynamic
companyId Company ID integer
The company ID related to the contact.
Required Dynamic
checkDuplicate Check Duplicate boolean
When this flag is set to true, if a duplicate record is found to the one being created, an error will be thrown instead of creating a duplicate record.
Optional
title Title string
The record's job title.
Optional
reportsToId Reports To Id integer
The ID of the contact that this contact reports to.
Optional Dynamic
hasLeftCompany Has Left Company boolean
Whether the contact has left the company or not.
Optional
emails Emails string[]
An array of email objects. Each email object should contain two keys: email and is_primary, as described here. Format: {"email":"example@email.com", "is_primary":"true"}
Optional
phones Phones string[]
An array of phone objects. Each phone object should contain three keys: number, extension, and type, as described here. Format: {"number":"+16124063451", "extension":"8371", "type":"mobile"}. Type can be mobile, home, work, fax, main or other
Optional
addressStreet Street Address string
The street of the record's address.
Optional
addressCity City Address string
The city of the record's address.
Optional
addressState State Address string
The state of the record's address.
Optional
addressPostalCode Address Postal Code string
The postal code of the record's address.
Optional
countryCode Country Code string
The country code of the record.
Optional
socialMediaUrls Social Media URLs string[]
The social media URLs of the record.
Optional
isHot Is Hot boolean
Whether the record is marked as hot.
Optional
notes Notes string
Any notes about the record.
Optional
customFields Custom Fields string[]
An array of custom field objects.
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
cats-create-contact
Version
0.0.2
App
CATS
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes