Relate Records
copper.relate_record
ActionCRM & salesconnection required
Calls the Copper API with the connection's credentials.
Link an existing Copper record to another record as a related item.
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
4 fields, 4 required. A dotted path is a nested object and name[] an array of objects — the editor renders the same tree.
| Field | Type | Required | Default | Constraints | Example |
|---|---|---|---|---|---|
entity Which kind of record you are starting from. | string | Yes | — | one of "people", "companies", "leads", "opportunities", "projects", "tasks" | — |
record_id The id of that record. | string | Yes | — | — | — |
resource_type The singular type of the record to relate, as Copper names it. | string | Yes | — | one of "person", "company", "lead", "opportunity", "project", "task" | — |
resource_id The id of the record to relate. | string | Yes | — | — | 2827700 |
Example configuration
Every value below is the contract’s own example or default — nothing invented.
{
"resource_id": "2827700"
}Output
One shape.
result
| Field | Type | Example |
|---|---|---|
added True when Copper confirmed the link was added. | boolean | — |
resource The id and type Copper echoed back. | object | — |
{
"added": false,
"resource": {}
}See Relate Records 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.