View as Markdown
Agiliron icon

Agiliron ACTION

Create Contact

Generates a new contact within Agiliron. See the documentation
  • Action
  • Writes data
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Agiliron 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: "agiliron-create-contact",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    agiliron: { authProvisionId: "apn_xxxxxxx" },
    salutation: "Salutation",
    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
salutation Salutation string
The salutation of the lead
Optional
lastname Last Name string
The last name of the contact.
Required
firstName First Name string
The first name of the contact
Optional
officePhone Office Phone string
The office phone number of the contact
Optional
mobile Mobile string
The mobile number of the contact
Optional
homePhone Home Phone string
The home phone number of the contact
Optional
otherPhone Other Phone string
An additional phone number of the contact
Optional
fax Fax string
The fax number of the contact
Optional
accountName Account Name string
The account name of the contact
Optional
accountId Account ID string
The account id of the contact
Optional
vendorName Vendor Name string
The vendor name of the contact
Optional
vendorId Vendor ID string
The vendor id of the contact
Optional
contactType Contact Type string
The contact type of the contact
Optional
title Title string
The title of the contact.
Optional
department Department string
The department of the contact.
Optional
email Email string
The email address of the contact
Optional
yahooId Yahoo ID string
The Yahoo ID of the contact
Optional
emailOptOut Email Opt Out string
The email opt-out status of the contact
Optional
assignedTo Assigned To string
The user to whom the contact is assigned
Optional
leadSource Lead Source string
The lead source of the contact
Optional
birthday Birthday string
The birthday of the contact.
Optional
mailingStreet Mailing Street string
The mailing street address of the contact
Optional
mailingCity Mailing City string
The mailing city of the contact
Optional
mailingState Mailing State string
The mailing state of the contact
Optional
mailingZip Mailing Zip string
The mailing zip code of the contact
Optional
mailingCountry Mailing Country string
The mailing country of the contact
Optional
otherStreet Other Street string
The other street address of the contact
Optional
otherCity Other City string
The other city of the contact
Optional
otherState Other State string
The other state of the contact
Optional
otherZip Other Zip string
The other zip code of the contact
Optional
otherCountry Other Country string
The other country of the contact
Optional
description Description string
The description of the contact
Optional
customFields Custom Fields object
An object of custom fields for the contact. Format: {customFieldName01: "Value 01"}
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
agiliron-create-contact
Version
0.0.2
App
Agiliron
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes