Copper

Copper is a customer relationship management (CRM) software designed to streamline and optimize sales processes, providing tools for managing contact, leads, opportunities, and communications in one centralized platform.

Categories: CRM

Type: copper/v1

Connections

Version: 1

API Key

Properties

Name	Label	Type	Description	Required
username	Email address	STRING		true
key	Key	STRING		true

Actions

Create Activity

Name: createActivity

Creates a new activity.

Properties

Name	Label	Type	Description	Required
activity_type	Activity Type ID	STRING	Id of activity type for this activity.	true
details	Details	STRING	Text body of this activity.	true
type	Parent Type	STRING Options lead, person, company, opportunity	Parent type to associate this activity with.	true
id	Parent ID	STRING Depends On type	ID of the parent this activity will be associated with.	true

Example JSON Structure

{
  "label" : "Create Activity",
  "name" : "createActivity",
  "parameters" : {
    "activity_type" : "",
    "details" : "",
    "type" : "",
    "id" : ""
  },
  "type" : "copper/v1/createActivity"
}

Output

Type: OBJECT

Properties

Name	Type	Description
id	STRING	The ID of the new activity.
type	OBJECT Properties {STRING(category), STRING(id)}	The type of the new activity.
details	STRING	Text body of the new activity.
parent	OBJECT Properties {STRING(type), STRING(id)}	The resource to which this new activity belongs.

Output Example

{
  "id" : "",
  "type" : {
    "category" : "",
    "id" : ""
  },
  "details" : "",
  "parent" : {
    "type" : "",
    "id" : ""
  }
}

Create Company

Name: createCompany

Creates a new company.

Properties

Name	Label	Type	Description	Required
name	Name	STRING	The name of the company.	true
assignee_id	Assignee ID	STRING	ID of the user that will be the owner of the company.	false
email_domain	Email Domain	STRING	The domain to which email addresses for the company belong.	false
contact_type_id	Contact Type ID	STRING	ID of the Contact type for the company.	false
details	Details	STRING	Description of the company.	false
phone_numbers	Phone Numbers	ARRAY Items [{STRING(number), STRING(category)}]	Phone numbers belonging to the company.	false
socials	Socials	ARRAY Items [{STRING(url), STRING(category)}]	Social profiles belonging to the company.	false
websites	Websites	ARRAY Items [{STRING(url), STRING(category)}]	Websites belonging to the company.	false
address	Address	OBJECT Properties {STRING(street), STRING(city), STRING(state), STRING(postal_code), STRING(country)}	Company's street, city, state, postal code, and country.	false
tags	Tags	ARRAY Items [STRING]	Tags associated with the company	false

Example JSON Structure

{
  "label" : "Create Company",
  "name" : "createCompany",
  "parameters" : {
    "name" : "",
    "assignee_id" : "",
    "email_domain" : "",
    "contact_type_id" : "",
    "details" : "",
    "phone_numbers" : [ {
      "number" : "",
      "category" : ""
    } ],
    "socials" : [ {
      "url" : "",
      "category" : ""
    } ],
    "websites" : [ {
      "url" : "",
      "category" : ""
    } ],
    "address" : {
      "street" : "",
      "city" : "",
      "state" : "",
      "postal_code" : "",
      "country" : ""
    },
    "tags" : [ "" ]
  },
  "type" : "copper/v1/createCompany"
}

Output

Type: OBJECT

Properties

Name	Type	Description
id	STRING	ID of the new company.
name	STRING	Name of the new company.
address	OBJECT Properties {STRING(street), STRING(city), STRING(state), STRING(postal_code), STRING(country)}	Address of the new company.
assignee_id	STRING	ID of the user that is owner of the new company.
contact_type_id	STRING	ID of the contact type of the new company.
details	STRING	Description of the new company.
email_domain	STRING	Domain to which email addresses of the new company belong.
phone_numbers	ARRAY Items [{STRING(number), STRING(category)}]	Phone numbers belonging to the new company.
socials	ARRAY Items [{STRING(url), STRING(category)}]	Social profiles belonging to the company.
tags	ARRAY Items [STRING]	Tags associated with the company.
websites	ARRAY Items [{STRING(url), STRING(category)}]	Websites belonging to the company.

Output Example

{
  "id" : "",
  "name" : "",
  "address" : {
    "street" : "",
    "city" : "",
    "state" : "",
    "postal_code" : "",
    "country" : ""
  },
  "assignee_id" : "",
  "contact_type_id" : "",
  "details" : "",
  "email_domain" : "",
  "phone_numbers" : [ {
    "number" : "",
    "category" : ""
  } ],
  "socials" : [ {
    "url" : "",
    "category" : ""
  } ],
  "tags" : [ "" ],
  "websites" : [ {
    "url" : "",
    "category" : ""
  } ]
}

Create Person

Name: createPerson

Creates a new person.

Properties

Name	Label	Type	Description	Required
name	Name	STRING	The first and last name of the person.	true
emails	Emails	ARRAY Items [{STRING(email), STRING(category)}($Email)]	Email addresses belonging to the person.	false
assignee_id	Assignee ID	STRING	User ID that will be the owner of the person.	false
title	Title	STRING	The professional title of the person.	false
company_id	Company ID	STRING	ID of the primary company with which the person is associated.	false
contact_type_id	Contact Type ID	STRING	The unique identifier of the contact type of the person.	false
details	Details	STRING	Description of the person.	false
phone_numbers	Phone Numbers	ARRAY Items [{STRING(number), STRING(category)}]	Phone numbers belonging to the person.	false
socials	Socials	ARRAY Items [{STRING(url), STRING(category)}]	Social profiles belonging to the person.	false
websites	Websites	ARRAY Items [{STRING(url), STRING(category)}]	Websites belonging to the person.	false
address	Address	OBJECT Properties {STRING(street), STRING(city), STRING(state), STRING(postal_code), STRING(country)}	Person's street, city, state, postal code, and country.	false
tags	Tags	ARRAY Items [STRING]	Tags associated with the person.	false

Example JSON Structure

{
  "label" : "Create Person",
  "name" : "createPerson",
  "parameters" : {
    "name" : "",
    "emails" : [ {
      "email" : "",
      "category" : ""
    } ],
    "assignee_id" : "",
    "title" : "",
    "company_id" : "",
    "contact_type_id" : "",
    "details" : "",
    "phone_numbers" : [ {
      "number" : "",
      "category" : ""
    } ],
    "socials" : [ {
      "url" : "",
      "category" : ""
    } ],
    "websites" : [ {
      "url" : "",
      "category" : ""
    } ],
    "address" : {
      "street" : "",
      "city" : "",
      "state" : "",
      "postal_code" : "",
      "country" : ""
    },
    "tags" : [ "" ]
  },
  "type" : "copper/v1/createPerson"
}

Output

Type: OBJECT

Properties

Name	Type	Description
id	STRING	ID of the new person.
name	STRING	First and last name of the new person.
address	OBJECT Properties {STRING(street), STRING(city), STRING(state), STRING(postal_code), STRING(country)}	Address of the new person.
assignee_id	STRING	ID of the user that is owner of the new person.
company_id	STRING	ID of the primary company with which the new person is associated.
company_name	STRING	The name of the primary company with which the new person is associated.
contact_type_id	STRING	ID of the contact type of the new person.
details	STRING	Description of the new person.
emails	ARRAY Items [{STRING(email), STRING(category)}]	Email addresses belonging to the new person.
phone_numbers	ARRAY Items [{STRING(number), STRING(category)}]	Phone numbers belonging to the new person.
socials	ARRAY Items [{STRING(url), STRING(category)}]	Social profiles belonging to the person.
tags	ARRAY Items [STRING]	Tags associated with the person.
title	STRING
websites	ARRAY Items [{STRING(url), STRING(category)}]	Websites belonging to the person.

Output Example

{
  "id" : "",
  "name" : "",
  "address" : {
    "street" : "",
    "city" : "",
    "state" : "",
    "postal_code" : "",
    "country" : ""
  },
  "assignee_id" : "",
  "company_id" : "",
  "company_name" : "",
  "contact_type_id" : "",
  "details" : "",
  "emails" : [ {
    "email" : "",
    "category" : ""
  } ],
  "phone_numbers" : [ {
    "number" : "",
    "category" : ""
  } ],
  "socials" : [ {
    "url" : "",
    "category" : ""
  } ],
  "tags" : [ "" ],
  "title" : "",
  "websites" : [ {
    "url" : "",
    "category" : ""
  } ]
}

Create Task

Name: createTask

Creates a new task in Copper.

Properties

Name	Label	Type	Description	Required
name	Name	STRING	The name of the task.	true
assignee_id	Assignee ID	STRING	ID of the user to assign the task to.	false
due_date	Due Date	DATE	The due date of the task.	false
reminder_date	Reminder Date	DATE	The reminder date of the task.	false
details	Description	STRING	Description of the task.	false
priority	Priority	STRING Options None, Low, Medium, High	The priority of the task.	true
tags	Tags	ARRAY Items [STRING]		false
status	Status	STRING Options Open, Completed	The status of the task.	true

Example JSON Structure

{
  "label" : "Create Task",
  "name" : "createTask",
  "parameters" : {
    "name" : "",
    "assignee_id" : "",
    "due_date" : "2021-01-01",
    "reminder_date" : "2021-01-01",
    "details" : "",
    "priority" : "",
    "tags" : [ "" ],
    "status" : ""
  },
  "type" : "copper/v1/createTask"
}

Output

Type: OBJECT

Properties

Name	Type	Description
id	STRING	ID of the new task.
name	STRING	Name of the new task.
related_resource	OBJECT Properties {STRING(id), STRING(type)}	Primary related resource for the new task.
assignee_id	STRING	ID of the user that is owner of the new task.
due_date	STRING	The due date of the new task.
reminder_date	STRING	The reminder date of the new task.
completed_date	STRING	The date the task was completed.
priority	STRING	The priority of the new task.
status	STRING	The status of the new task.
details	STRING	Description of the new task.
tags	ARRAY Items [STRING]	Tags associated with the new task.

Output Example

{
  "id" : "",
  "name" : "",
  "related_resource" : {
    "id" : "",
    "type" : ""
  },
  "assignee_id" : "",
  "due_date" : "",
  "reminder_date" : "",
  "completed_date" : "",
  "priority" : "",
  "status" : "",
  "details" : "",
  "tags" : [ "" ]
}

What to do if your action is not listed here?

If this component doesn't have the action you need, you can use Custom Action to create your own. Custom Actions empower you to define HTTP requests tailored to your specific requirements, allowing for greater flexibility in integrating with external services or APIs.

To create a Custom Action, simply specify the desired HTTP method, path, and any necessary parameters. This way, you can extend the functionality of your component beyond the predefined actions, ensuring that you can meet all your integration needs effectively.

On this page