Create or Update Person with Copper API

Pipedream makes it easy to connect APIs for Copper and 2,200+ other apps remarkably fast.

Trigger workflow on

HTTP requests, schedules and app events

Next, do this

Create or Update Person with the Copper API

No credit card required

▶

Watch us build a workflow

8 min

Watch now ➜

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

Developers ♥ Pipedream

Getting Started#

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

Configure the Create or Update Person action
1. Connect your Copper account
2. Configure Email
3. Optional- Configure Name
4. Optional- Configure Street Address
5. Optional- Configure City
6. Optional- Configure State
7. Optional- Configure Postal Code
8. Optional- Configure Country
9. Optional- Configure Phone
Select a trigger to run your workflow on HTTP requests, schedules or app events
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Integrations#

Create or Update Person with Copper API on New Requests (Payload Only) from HTTP / Webhook API

HTTP / Webhook + Copper

Try it

Create or Update Person with Copper API on New Submission from Typeform API

Typeform + Copper

Try it

Create or Update Person with Copper API on New Submission (Instant) from Jotform API

Jotform + Copper

Try it

Create or Update Person with Copper API on New Scheduled Tasks from Pipedream API

Pipedream + Copper

Try it

Create or Update Person with Copper API on New Download Counts from npm API

npm + Copper

Try it

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 or Update Person on Copper

Description:Creates a new person or updates an existing one based on email address. [See the documentation](https://developer.copper.com/people/create-a-new-person.html)

Version:0.0.1

Key:copper-create-update-person

View on GitHub

Code#

import copper from "../../copper.app.mjs";
import { ConfigurationError } from "@pipedream/platform";

export default {
  key: "copper-create-update-person",
  name: "Create or Update Person",
  description: "Creates a new person or updates an existing one based on email address. [See the documentation](https://developer.copper.com/people/create-a-new-person.html)",
  version: "0.0.1",
  type: "action",
  props: {
    copper,
    email: {
      type: "string",
      label: "Email",
      description: "Email address of the person. If email already exists, the person will be updated",
    },
    name: {
      type: "string",
      label: "Name",
      description: "Name of the contact. Required if creating a new person.",
      optional: true,
    },
    streetAddress: {
      type: "string",
      label: "Street Address",
      description: "Street address of the person",
      optional: true,
    },
    city: {
      type: "string",
      label: "City",
      description: "City address of the person",
      optional: true,
    },
    state: {
      type: "string",
      label: "State",
      description: "State address of the person",
      optional: true,
    },
    postalCode: {
      type: "string",
      label: "Postal Code",
      description: "Postal code of the person",
      optional: true,
    },
    country: {
      type: "string",
      label: "Country",
      description: "Country of the person",
      optional: true,
    },
    phone: {
      type: "string",
      label: "Phone",
      description: "Phone number of the person",
      optional: true,
    },
  },
  async run({ $ }) {
    let response;
    const hasAddress = this.streetAddress
      || this.city
      || this.state
      || this.postalCode
      || this.country;
    const data = {
      emails: [
        {
          email: this.email,
          category: "work",
        },
      ],
      name: this.name,
      address: hasAddress && {
        street: this.streetAddress,
        city: this.city,
        state: this.state,
        postal_code: this.postalCode,
        country: this.country,
      },
      phone_numbers: this.phone && [
        {
          number: this.phone,
          category: "work",
        },
      ],
    };

    // search for the person
    const person = await this.copper.listObjects({
      $,
      objectType: "people",
      data: {
        emails: [
          this.email,
        ],
      },
    });

    if (!person?.length && !this.name) {
      throw new ConfigurationError(`Person with email ${this.email} not found. Name is required for creating a new person.`);
    }

    // create person if not found
    if (!person?.length) {
      response = await this.copper.createPerson({
        $,
        data,
      });
    }
    // update person if found
    else {
      response = await this.copper.updatePerson({
        $,
        personId: person[0].id,
        data,
      });
    }

    $.export("$summary", `Successfully ${person?.length
      ? "updated"
      : "created"} person with ID: ${response.id}`);
    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.

Label	Prop	Type	Description
Copper	`copper`	`app`	This component uses the Copper app.
Email	`email`	`string`	Email address of the person. If email already exists, the person will be updated
Name	`name`	`string`	Name of the contact. Required if creating a new person.
Street Address	`streetAddress`	`string`	Street address of the person
City	`city`	`string`	City address of the person
State	`state`	`string`	State address of the person
Postal Code	`postalCode`	`string`	Postal code of the person
Country	`country`	`string`	Country of the person
Phone	`phone`	`string`	Phone number of the person