View as Markdown
FreeAgent icon

FreeAgent ACTION

Create Contact

Create a contact in FreeAgent. See the documentation.
  • Action
  • Writes data
  • OAuth
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's FreeAgent 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: "freeagent-create-contact",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    freeagent: { 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 contact. Required if Organisation Name is not provided.
Optional
lastName Last Name string
The last name of the contact. Required if Organisation Name is not provided.
Optional
organisationName Organisation Name string
The name of the organisation. Required if First Name and Last Name are not provided.
Optional
email Email string
The email of the contact
Optional
billingEmail Billing Email string
The billing email of the contact
Optional
phoneNumber Phone Number string
The phone number of the contact
Optional
mobile Mobile string
The mobile number of the contact
Optional
address1 Address 1 string
The first address line of the contact
Optional
address2 Address 2 string
The second address line of the contact
Optional
address3 Address 3 string
The third address line of the contact
Optional
town Town / City string
The town or city of the contact
Optional
region Region / State string
The region or state of the contact
Optional
postcode Postcode / ZIP string
The postcode or ZIP code of the contact
Optional
country Country string
The country of the contact
Optional
contactNameOnInvoices Contact Name on Invoices boolean
If true, the contact name will be shown on invoices as well as the organization name.
Optional
defaultPaymentTermsInDays Default Payment Terms (Days) integer
The default payment terms in days for the contact
Optional
locale Locale string
Invoice/Estimate language
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
freeagent-create-contact
Version
0.0.1
App
FreeAgent
Authentication
OAuth
Read-only
No
Destructive
No
Open world
Yes