Create Lead

copper.create_lead
ActionCRM & salesconnection required

Calls the Copper API with the connection's credentials.

Create a Lead in Copper. Copper requires only a name, and a Lead holds a single email address rather than a list.

Connection

Required
Yes — the node will not save without one
Auth type
API key
Providers
Copper
Secret shape
the API key, or {"api_key": "…"}
Config it needs
user_email, base_url
Resolved by
config.connection_id, else node.connection_id

Configuration

14 fields, 1 required. A dotted path is a nested object and name[] an array of objects — the editor renders the same tree.

FieldTypeRequiredDefaultConstraintsExample
name
The lead's full name.
stringYes——Jane Doe
email
The lead's email address.
stringNo—email formatjane@example.com
email_category
Which address this is, in Copper's own category vocabulary.
stringConditionalworkone of "work", "personal", "other"; only with email—
phone
A phone number for the lead.
stringNo———
phone_category
Which number this is, in Copper's own category vocabulary.
stringConditionalworkone of "work", "mobile", "home", "other"; only with phone—
company_name
The company the lead works for, as free text; a Lead has no company id.
stringNo———
title
The lead's job title.
stringNo———
monetary_value
The value of the lead in the account currency.
numberNo—≥ 0—
status
A lead status name from copper.list_lead_statuses, such as New.
stringNo———
customer_source_id
A customer source id from copper.list_customer_sources.
stringNo———
details
A description stored on the record.
stringNo———
assignee_id
The Copper user who should own this record.
stringNo———
tags
Tags to set on the record, as a JSON array of strings or a comma-separated list.
arrayNo—array of string—
fields
Any further Copper fields, as a JSON object of Copper field names (custom_fields, address, websites, socials …). These are merged over the fields named above, so this node can set anything the API accepts.
objectNo———

Example configuration

Every value below is the contract’s own example or default — nothing invented.

{
  "email": "jane@example.com",
  "email_category": "work",
  "name": "Jane Doe",
  "phone_category": "work"
}

Output

One shape.

result

The provider's response object, as returned.

Extra keys beyond the ones listed can appear.

{}

See Create Lead run in a workflow.

In a technical demo we add the Copper connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.