← FreeAgent

Create Contact with FreeAgent API

Pipedream makes it easy to connect APIs for FreeAgent and 3,000+ other apps remarkably fast.

Trigger workflow on
HTTP requests, schedules and app events
Next, do this
Create Contact with the FreeAgent API
No credit card required
Intro to Pipedream
Watch us build a workflow
Watch us build a workflow
8 min
Watch now ➜

Trusted by 1,000,000+ developers from startups to Fortune 500 companies

Adyen logo
Appcues logo
Bandwidth logo
Checkr logo
ChartMogul logo
Dataminr logo
Gopuff logo
Gorgias logo
LinkedIn logo
Logitech logo
Replicated logo
Rudderstack logo
SAS logo
Scale AI logo
Webflow logo
Warner Bros. logo
Adyen logo
Appcues logo
Bandwidth logo
Checkr logo
ChartMogul logo
Dataminr logo
Gopuff logo
Gorgias logo
LinkedIn logo
Logitech logo
Replicated logo
Rudderstack logo
SAS logo
Scale AI logo
Webflow logo
Warner Bros. logo

Developers Pipedream

Getting Started

Create a workflow to Create Contact with the FreeAgent API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

  1. Configure the Create Contact action
    1. Connect your FreeAgent account
    2. Optional- Configure First Name
    3. Optional- Configure Last Name
    4. Optional- Configure Organisation Name
    5. Optional- Configure Email
    6. Optional- Configure Billing Email
    7. Optional- Configure Phone Number
    8. Optional- Configure Mobile
    9. Optional- Configure Address 1
    10. Optional- Configure Address 2
    11. Optional- Configure Address 3
    12. Optional- Configure Town / City
    13. Optional- Configure Region / State
    14. Optional- Configure Postcode / ZIP
    15. Optional- Configure Country
    16. Optional- Configure Contact Name on Invoices
    17. Optional- Configure Default Payment Terms (Days)
    18. Optional- Select a Locale
  2. Select a trigger to run your workflow on HTTP requests, schedules or app events
  3. Deploy the workflow
  4. Send a test event to validate your setup
  5. Turn on the trigger

Details

This is a pre-built, source-available component from Pipedream's GitHub repo. The component is developed by Pipedream and the community, and verified and maintained by Pipedream.

To contribute an update to an existing component or create a new component, create a PR on GitHub. If you're new to Pipedream component development, you can start with quickstarts for trigger span and action development, and then review the component API reference.

Create Contact on FreeAgent
Description:Create a contact in FreeAgent. [See the documentation](https://dev.freeagent.com/docs/contacts#create-a-contact).
Version:0.0.1
Key:freeagent-create-contact

Code

import { ConfigurationError } from "@pipedream/platform";
import { LOCALE_OPTIONS } from "../../common/constants.mjs";
import { getId } from "../../common/utils.mjs";
import freeagent from "../../freeagent.app.mjs";

export default {
  key: "freeagent-create-contact",
  name: "Create Contact",
  description: "Create a contact in FreeAgent. [See the documentation](https://dev.freeagent.com/docs/contacts#create-a-contact).",
  version: "0.0.1",
  type: "action",
  annotations: {
    destructiveHint: false,
    openWorldHint: true,
    readOnlyHint: false,
  },
  props: {
    freeagent,
    firstName: {
      type: "string",
      label: "First Name",
      description: "The first name of the contact. Required if `Organisation Name` is not provided.",
      optional: true,
    },
    lastName: {
      type: "string",
      label: "Last Name",
      description: "The last name of the contact. Required if `Organisation Name` is not provided.",
      optional: true,
    },
    organisationName: {
      type: "string",
      label: "Organisation Name",
      description: "The name of the organisation. Required if `First Name` and `Last Name` are not provided.",
      optional: true,
    },
    email: {
      type: "string",
      label: "Email",
      description: "The email of the contact",
      optional: true,
    },
    billingEmail: {
      type: "string",
      label: "Billing Email",
      description: "The billing email of the contact",
      optional: true,
    },
    phoneNumber: {
      type: "string",
      label: "Phone Number",
      description: "The phone number of the contact",
      optional: true,
    },
    mobile: {
      type: "string",
      label: "Mobile",
      description: "The mobile number of the contact",
      optional: true,
    },
    address1: {
      type: "string",
      label: "Address 1",
      description: "The first address line of the contact",
      optional: true,
    },
    address2: {
      type: "string",
      label: "Address 2",
      description: "The second address line of the contact",
      optional: true,
    },
    address3: {
      type: "string",
      label: "Address 3",
      description: "The third address line of the contact",
      optional: true,
    },
    town: {
      type: "string",
      label: "Town / City",
      description: "The town or city of the contact",
      optional: true,
    },
    region: {
      type: "string",
      label: "Region / State",
      description: "The region or state of the contact",
      optional: true,
    },
    postcode: {
      type: "string",
      label: "Postcode / ZIP",
      description: "The postcode or ZIP code of the contact",
      optional: true,
    },
    country: {
      type: "string",
      label: "Country",
      description: "The country of the contact",
      optional: true,
    },
    contactNameOnInvoices: {
      type: "boolean",
      label: "Contact Name on Invoices",
      description: "If true, the contact name will be shown on invoices as well as the organization name.",
      optional: true,
    },
    defaultPaymentTermsInDays: {
      type: "integer",
      label: "Default Payment Terms (Days)",
      description: "The default payment terms in days for the contact",
      optional: true,
    },
    locale: {
      type: "string",
      label: "Locale",
      description: "Invoice/Estimate language",
      optional: true,
      options: LOCALE_OPTIONS,
    },
  },
  async run({ $ }) {
    const hasOrg = this.organisationName;
    const hasPerson = this.firstName && this.lastName;
    if (!hasOrg && !hasPerson) {
      throw new ConfigurationError("Provide either `Organisation Name` OR both `First Name` and `Last Name`.");
    }

    const response = await this.freeagent.createContact({
      $,
      data: {
        first_name: this.firstName,
        last_name: this.lastName,
        organisation_name: this.organisationName,
        email: this.email,
        billing_email: this.billingEmail,
        phone_number: this.phoneNumber,
        mobile: this.mobile,
        address1: this.address1,
        address2: this.address2,
        address3: this.address3,
        town: this.town,
        region: this.region,
        postcode: this.postcode,
        country: this.country,
        contact_name_on_invoices: this.contactNameOnInvoices,
        default_payment_terms_in_days: this.defaultPaymentTermsInDays,
        locale: this.locale,
      },
    });
    $.export("$summary", `Successfully created contact with ID: \`${getId(response.contact.url)}\``);
    return response;
  },
};

Configuration

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI and CLI.
LabelPropTypeDescription
FreeAgentfreeagentappThis component uses the FreeAgent app.
First NamefirstNamestring

The first name of the contact. Required if Organisation Name is not provided.

Last NamelastNamestring

The last name of the contact. Required if Organisation Name is not provided.

Organisation NameorganisationNamestring

The name of the organisation. Required if First Name and Last Name are not provided.

Emailemailstring

The email of the contact

Billing EmailbillingEmailstring

The billing email of the contact

Phone NumberphoneNumberstring

The phone number of the contact

Mobilemobilestring

The mobile number of the contact

Address 1address1string

The first address line of the contact

Address 2address2string

The second address line of the contact

Address 3address3string

The third address line of the contact

Town / Citytownstring

The town or city of the contact

Region / Stateregionstring

The region or state of the contact

Postcode / ZIPpostcodestring

The postcode or ZIP code of the contact

Countrycountrystring

The country of the contact

Contact Name on InvoicescontactNameOnInvoicesboolean

If true, the contact name will be shown on invoices as well as the organization name.

Default Payment Terms (Days)defaultPaymentTermsInDaysinteger

The default payment terms in days for the contact

LocalelocalestringSelect a value from the drop down menu:{ "label": "Bulgarian", "value": "bg" }{ "label": "Catalan", "value": "ca" }{ "label": "Welsh", "value": "cy" }{ "label": "Czech", "value": "cz" }{ "label": "German", "value": "de" }{ "label": "Danish", "value": "dk" }{ "label": "English (United States)", "value": "en-US" }{ "label": "Spanish", "value": "es" }{ "label": "Estonian", "value": "et" }{ "label": "Finnish", "value": "fi" }{ "label": "French", "value": "fr" }{ "label": "French (Belgium)", "value": "fr-BE" }{ "label": "French (Canada)", "value": "fr-CA" }{ "label": "Icelandic", "value": "is" }{ "label": "Italian", "value": "it" }{ "label": "Latvian", "value": "lv-LV" }{ "label": "Dutch", "value": "nl" }{ "label": "Dutch (Belgium)", "value": "nl-BE" }{ "label": "Norwegian", "value": "nk" }{ "label": "Polish", "value": "pl-PL" }{ "label": "Brazilian Portuguese", "value": "pt-BR" }{ "label": "Romanian", "value": "ro" }{ "label": "Serbian", "value": "rs" }{ "label": "Russian", "value": "ru" }{ "label": "Swedish", "value": "se" }{ "label": "Slovak", "value": "sk" }{ "label": "Turkish", "value": "tr" }

Authentication

FreeAgent uses OAuth authentication. When you connect your FreeAgent account, Pipedream will open a popup window where you can sign into FreeAgent and grant Pipedream permission to connect to your account. Pipedream securely stores and automatically refreshes the OAuth tokens so you can easily authenticate any FreeAgent API.

Pipedream requests the following authorization scopes when you connect your account:

About FreeAgent

Accounting software for small businesses

More Ways to Use FreeAgent

Triggers

New Contact from the FreeAgent API

Emit new event when a new contact is created. See the documentation

 
Try it
New Invoice from the FreeAgent API

Emit new event when a new invoice is created. See the documentation

 
Try it
New Task from the FreeAgent API

Emit new event when a new task is created. See the documentation

 
Try it

Actions

Create Task with the FreeAgent API

Create a task under a specific project in FreeAgent. See the documentation

 
Try it

Explore Other Apps

1
-
24
of
3,000+
apps by most popular

Node
Node
Anything you can do with Node.js, you can do in a Pipedream workflow. This includes using most of npm's 400,000+ packages.
Python
Python
Anything you can do in Python can be done in a Pipedream Workflow. This includes using any of the 350,000+ PyPi packages available in your Python powered workflows.
Notion
Notion
Notion is a new tool that blends your everyday work apps into one. It's the all-in-one workspace for you and your team.
OpenAI (ChatGPT)
OpenAI (ChatGPT)
OpenAI is an AI research and deployment company with the mission to ensure that artificial general intelligence benefits all of humanity. They are the makers of popular models like ChatGPT, DALL-E, and Whisper.
Anthropic (Claude)
Anthropic (Claude)
AI research and products that put safety at the frontier. Introducing Claude, a next-generation AI assistant for your tasks, no matter the scale.
Google Sheets
Google Sheets
Use Google Sheets to create and edit online spreadsheets. Get insights together with secure sharing in real-time and from any device.
Telegram
Telegram
Telegram, is a cloud-based, cross-platform, encrypted instant messaging (IM) service.
Google Drive
Google Drive
Google Drive is a file storage and synchronization service which allows you to create and share your work online, and access your documents from anywhere.
HTTP / Webhook
HTTP / Webhook
Get a unique URL where you can send HTTP or webhook requests
Google Calendar
Google Calendar
With Google Calendar, you can quickly schedule meetings and events and get reminders about upcoming activities, so you always know what’s next.
Schedule
Schedule
Trigger workflows on an interval or cron schedule.
Pipedream Utils
Pipedream Utils
Utility functions to use within your Pipedream workflows
Shopify
Shopify
Shopify is a complete commerce platform that lets anyone start, manage, and grow a business. You can use Shopify to build an online store, manage sales, market to customers, and accept payments in digital and physical locations.
Supabase
Supabase
Supabase is an open source Firebase alternative.
MySQL
MySQL
MySQL is an open-source relational database management system.
PostgreSQL
PostgreSQL
PostgreSQL is a free and open-source relational database management system emphasizing extensibility and SQL compliance.
AWS
AWS
Premium
Amazon Web Services (AWS) offers reliable, scalable, and inexpensive cloud computing services.
Twilio SendGrid
Twilio SendGrid
Premium
Send marketing and transactional email through the Twilio SendGrid platform with the Email API, proprietary mail transfer agent, and infrastructure for scalable delivery.
Amazon SES
Amazon SES
Amazon SES is a cloud-based email service provider that can integrate into any application for high volume email automation
Klaviyo
Klaviyo
Premium
Klaviyo unifies your data, channels, and AI agents in one platform—text, WhatsApp, email marketing, and more—driving growth with every interaction.
Zendesk
Zendesk
Premium
Zendesk is award-winning customer service software trusted by 200K+ customers. Make customers happy via text, mobile, phone, email, live chat, social media.
ServiceNow
ServiceNow
Premium
Beta
The smarter way to workflow
Slack
Slack
Slack is the AI-powered platform for work bringing all of your conversations, apps, and customers together in one place. Around the world, Slack is helping businesses of all sizes grow and send productivity through the roof.
Microsoft Teams
Microsoft Teams
Microsoft Teams has communities, events, chats, channels, meetings, storage, tasks, and calendars in one place.