Skip to content

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

NameLabelTypeControl TypeDescriptionRequired
usernameEmail addressSTRINGTEXTtrue
keyKeySTRINGTEXTtrue

Actions

Create Activity

Name: createActivity

Creates a new activity.

Properties

NameLabelTypeControl TypeDescriptionRequired
activity_typeActivity Type IDSTRINGSELECTId of activity type for this activity.true
detailsDetailsSTRINGTEXTText body of this activity.true
typeParent TypeSTRINGSELECTParent type to associate this activity with.true
idParent IDSTRINGSELECTID of the parent this activity will be associated with.true

Output

Type: OBJECT

Properties

NameTypeControl Type
idSTRINGTEXT
type{STRING(category), STRING(id)}OBJECT_BUILDER
detailsSTRINGTEXT
parent{STRING(type), STRING(id)}OBJECT_BUILDER

Create Company

Name: createCompany

Creates a new company.

Properties

NameLabelTypeControl TypeDescriptionRequired
nameNameSTRINGTEXTThe name of the company.true
assignee_idAssignee IDSTRINGSELECTID of the user that will be the owner of the company.false
email_domainEmail DomainSTRINGTEXTThe domain to which email addresses for the company belong.false
contact_type_idContact Type IDSTRINGSELECTID of the Contact type for the company.false
detailsDetailsSTRINGTEXTDescription of the company.false
phone_numbersPhone Numbers[{STRING(number), STRING(category)}]ARRAY_BUILDERPhone numbers belonging to the company.false
socialsSocials[{STRING(url), STRING(category)}]ARRAY_BUILDERSocial profiles belonging to the company.false
websitesWebsites[{STRING(url), STRING(category)}]ARRAY_BUILDERWebsites belonging to the company.false
addressAddress{STRING(street), STRING(city), STRING(state), STRING(postal_code), STRING(country)}OBJECT_BUILDERCompany’s street, city, state, postal code, and country.false
tagsTags[STRING]ARRAY_BUILDERTags associated with the companyfalse

Output

Type: OBJECT

Properties

NameTypeControl Type
idSTRINGTEXT
nameSTRINGTEXT
address{STRING(street), STRING(city), STRING(state), STRING(postal_code), STRING(country)}OBJECT_BUILDER
assignee_idSTRINGTEXT
contact_type_idSTRINGTEXT
detailsSTRINGTEXT
email_domainSTRINGTEXT
phone_numbers[{STRING(number), STRING(category)}]ARRAY_BUILDER
socials[{STRING(url), STRING(category)}]ARRAY_BUILDER
tags[STRING]ARRAY_BUILDER
websites[{STRING(url), STRING(category)}]ARRAY_BUILDER

Create Person

Name: createPerson

Creates a new person.

Properties

NameLabelTypeControl TypeDescriptionRequired
nameNameSTRINGTEXTThe first and last name of the person.true
emailsEmails[{STRING(email), STRING(category)}($Email)]ARRAY_BUILDEREmail addresses belonging to the person.false
assignee_idAssignee IDSTRINGSELECTUser ID that will be the owner of the person.false
titleTitleSTRINGTEXTThe professional title of the person.false
company_idCompany IDSTRINGSELECTID of the primary company with which the person is associated.false
contact_type_idContact Type IDSTRINGSELECTThe unique identifier of the contact type of the person.false
detailsDetailsSTRINGTEXTDescription of the person.false
phone_numbersPhone Numbers[{STRING(number), STRING(category)}]ARRAY_BUILDERPhone numbers belonging to the person.false
socialsSocials[{STRING(url), STRING(category)}]ARRAY_BUILDERSocial profiles belonging to the person.false
websitesWebsites[{STRING(url), STRING(category)}]ARRAY_BUILDERWebsites belonging to the person.false
addressAddress{STRING(street), STRING(city), STRING(state), STRING(postal_code), STRING(country)}OBJECT_BUILDERPerson’s street, city, state, postal code, and country.false
tagsTags[STRING]ARRAY_BUILDERTags associated with the person.false

Output

Type: OBJECT

Properties

NameTypeControl Type
idSTRINGTEXT
nameSTRINGTEXT
address{STRING(street), STRING(city), STRING(state), STRING(postal_code), STRING(country)}OBJECT_BUILDER
assignee_idSTRINGTEXT
company_idSTRINGTEXT
contact_type_idSTRINGTEXT
detailsSTRINGTEXT
emails[{STRING(email), STRING(category)}]ARRAY_BUILDER
phone_numbers[{STRING(number), STRING(category)}]ARRAY_BUILDER
socials[{STRING(url), STRING(category)}]ARRAY_BUILDER
tags[STRING]ARRAY_BUILDER
titleSTRINGTEXT
websites[{STRING(url), STRING(category)}]ARRAY_BUILDER

Create Task

Name: createTask

Creates a new task in Copper.

Properties

NameLabelTypeControl TypeDescriptionRequired
nameNameSTRINGTEXTThe name of the task.true
assignee_idAssignee IDSTRINGSELECTID of the user to assign the task to.false
due_dateDue DateDATEDATEThe due date of the task.false
reminder_dateReminder DateDATEDATEThe reminder date of the task.false
detailsDescriptionSTRINGTEXTDescription of the task.false
priorityPrioritySTRINGSELECTThe priority of the task.true
tagsTags[STRING]ARRAY_BUILDERfalse
statusStatusSTRINGSELECTThe status of the task.true

Output

Type: OBJECT

Properties

NameTypeControl Type
idSTRINGTEXT
nameSTRINGTEXT
related_resource{STRING(id), STRING(type)}OBJECT_BUILDER
assignee_idSTRINGTEXT
due_dateSTRINGTEXT
reminder_dateSTRINGTEXT
completed_dateSTRINGTEXT
prioritySTRINGTEXT
statusSTRINGTEXT
detailsSTRINGTEXT
tags[STRING]ARRAY_BUILDER
custom_fields[]ARRAY_BUILDER
date_createdSTRINGTEXT
date_modifiedSTRINGTEXT