Copper¶

Node: copper · Full type: n8n-nodes-base.copper · Version: 1

Credentials¶

copperApi (alias: @copper)

CREDENTIAL @copper = copperApi "My Copper"

Operations¶

Resource: `company`¶

`create`¶

Parameter	Type	Default	Details
`name`	string	""	required
`additionalFields`	collection	{}	keys: `address`, `details`, `email_domain`, `phone_numbers`

`delete`¶

Parameter	Type	Default	Details
`companyId`	string	""	required

`get`¶

Parameter	Type	Default	Details
`companyId`	string	""	required

`getAll`¶

Parameter	Type	Default	Details
`returnAll`	boolean	false
`limit`	number	5
`filterFields`	collection	{}	keys: `country`, `name`

`update`¶

Parameter	Type	Default	Details
`companyId`	string	""	required
`updateFields`	collection	{}	keys: `address`, `details`, `name`, `phone_numbers`

Resource: `customerSource`¶

`getAll`¶

Parameter	Type	Default	Details
`returnAll`	boolean	false
`limit`	number	5

Resource: `lead`¶

`create`¶

Parameter	Type	Default	Details
`name`	string	""	required
`additionalFields`	collection	{}	keys: `address`, `email`, `phone_numbers`

`delete`¶

Parameter	Type	Default	Details
`leadId`	string	""	required

`get`¶

Parameter	Type	Default	Details
`leadId`	string	""	required

`getAll`¶

Parameter	Type	Default	Details
`returnAll`	boolean	false
`limit`	number	5
`filterFields`	collection	{}	keys: `country`, `name`

`update`¶

Parameter	Type	Default	Details
`leadId`	string	""	required
`updateFields`	collection	{}	keys: `address`, `details`, `email`, `name`, `phone_numbers`

Resource: `opportunity`¶

`create`¶

Parameter	Type	Default	Details
`name`	string	""	required
`customerSourceId`	string	""
`primaryContactId`	string	""

`delete`¶

Parameter	Type	Default	Details
`opportunityId`	string	""	required

`get`¶

Parameter	Type	Default	Details
`opportunityId`	string	""	required

`getAll`¶

Parameter	Type	Default	Details
`returnAll`	boolean	false
`limit`	number	5
`filterFields`	collection	{}	keys: `company_ids`, `customer_source_ids`

`update`¶

Parameter	Type	Default	Details
`opportunityId`	string	""	required
`updateFields`	collection	{}	keys: `customer_source_id`, `name`, `primary_contact_id`

Resource: `person`¶

`create`¶

Parameter	Type	Default	Details
`name`	string	""	required
`additionalFields`	collection	{}	keys: `address`, `details`, `email_domain`, `emails`, `phone_numbers`

`delete`¶

Parameter	Type	Default	Details
`personId`	string	""	required

`get`¶

Parameter	Type	Default	Details
`personId`	string	""	required

`getAll`¶

Parameter	Type	Default	Details
`returnAll`	boolean	false
`limit`	number	5
`filterFields`	collection	{}	keys: `name`

`update`¶

Parameter	Type	Default	Details
`personId`	string	""	required
`updateFields`	collection	{}	keys: `address`, `details`, `email_domain`, `emails`, `name`, `phone_numbers`

Resource: `project`¶

`create`¶

Parameter	Type	Default	Details
`name`	string	""	required
`additionalFields`	collection	{}	keys: `assignee_id`, `details`, `status`

`delete`¶

Parameter	Type	Default	Details
`projectId`	string	""	required

`get`¶

Parameter	Type	Default	Details
`projectId`	string	""	required

`getAll`¶

Parameter	Type	Default	Details
`returnAll`	boolean	false
`limit`	number	5
`filterFields`	collection	{}	keys: `name`

`update`¶

Parameter	Type	Default	Details
`projectId`	string	""	required
`updateFields`	collection	{}	keys: `assignee_id`, `details`, `name`, `status`

Resource: `task`¶

`create`¶

Parameter	Type	Default	Details
`name`	string	""	required
`additionalFields`	collection	{}	keys: `assignee_id`, `details`, `priority`, `status`

`delete`¶

Parameter	Type	Default	Details
`taskId`	string	""	required

`get`¶

Parameter	Type	Default	Details
`taskId`	string	""	required

`getAll`¶

Parameter	Type	Default	Details
`returnAll`	boolean	false
`limit`	number	5
`filterFields`	collection	{}	keys: `assignee_ids`, `project_ids`

`update`¶

Parameter	Type	Default	Details
`taskId`	string	""	required
`updateFields`	collection	{}	keys: `assignee_id`, `details`, `name`, `priority`, `status`

Resource: `user`¶

`getAll`¶

Parameter	Type	Default	Details
`returnAll`	boolean	false
`limit`	number	5

Parameter Details¶

additionalFields children:

Parameter	Type	Default	Details
`address`	fixedCollection	{}	groups: `addressFields`
`details`	string	""
`email_domain`	string	""
`phone_numbers`	fixedCollection	{}	groups: `phoneFields`

filterFields children:

Parameter	Type	Default	Details
`country`	options	""	`AF`, `AX`, `AL`, `DZ`, `AS`, `AD`, `AO`, `AI`, ... (249 total)
`name`	string	""

updateFields children:

Parameter	Type	Default	Details
`address`	fixedCollection	{}	groups: `addressFields`
`details`	string	""
`name`	string	""
`phone_numbers`	fixedCollection	{}	groups: `phoneFields`

Example¶

NODE "copper" @copper AS "Copper" {
  resource: "company",
  operation: "get",
  name: {{ $json.name }},
  companyId: {{ $json.companyId }},
  leadId: {{ $json.leadId }}
}

Copper¶

Credentials¶

Operations¶

Resource: company¶

create¶

delete¶

get¶

getAll¶

update¶

Resource: customerSource¶

getAll¶

Resource: lead¶

create¶

delete¶

get¶

getAll¶

update¶

Resource: opportunity¶

create¶

delete¶

get¶

getAll¶

update¶

Resource: person¶

create¶

delete¶

get¶

getAll¶

update¶

Resource: project¶

create¶

delete¶

get¶

getAll¶

update¶

Resource: task¶

create¶

delete¶

get¶

getAll¶

update¶

Resource: user¶

getAll¶

Parameter Details¶

Example¶

Resource: `company`¶

`create`¶

`delete`¶

`get`¶

`getAll`¶

`update`¶

Resource: `customerSource`¶

`getAll`¶

Resource: `lead`¶

`create`¶

`delete`¶

`get`¶

`getAll`¶

`update`¶

Resource: `opportunity`¶

`create`¶

`delete`¶

`get`¶

`getAll`¶

`update`¶

Resource: `person`¶

`create`¶

`delete`¶

`get`¶

`getAll`¶

`update`¶

Resource: `project`¶

`create`¶

`delete`¶

`get`¶

`getAll`¶

`update`¶

Resource: `task`¶

`create`¶

`delete`¶

`get`¶

`getAll`¶

`update`¶

Resource: `user`¶

`getAll`¶