Skip to main content
Copper logo
  • Category: crm
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 65
  • Triggers: 0
  • Slug: COPPER
  • Version: 20261101_00

Tools

Slug: COPPER_BULK_CREATE_ACTIVITIESAttempt to create 1-10 user-category Copper activities and return ordered per-item successes or validation failures. Deleting these activities is a soft delete: successful cleanup may leave an activity fetchable as an is_deleted=true stub rather than make it fully disappear. This Copper bulk endpoint is beta, accepts 1-10 records per request, returns results in request order, and has an additional limit of 3 requests per second.

Input Parameters

array
required
User-category activities to create in order.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COPPER_BULK_CREATE_COMPANIESAttempt to create 1-10 Copper companies and return ordered per-item successes or validation failures. This Copper bulk endpoint is beta, accepts 1-10 records per request, returns results in request order, and has an additional limit of 3 requests per second.

Input Parameters

array
required
Companies to create in order; each uses Copper’s single-company create fields.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COPPER_BULK_CREATE_LEADSCreate 1-10 Copper leads in one beta bulk request and return ordered per-item outcomes. Copper can return HTTP 500 after applying the write; treat failures as indeterminate and read records back before retrying to avoid duplicates.

Input Parameters

array
required
Between 1 and 10 leads to create. Results preserve this ordering.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COPPER_BULK_CREATE_OPPORTUNITIESAttempt to create 1-10 Copper opportunities and return ordered per-item successes or validation failures. This Copper bulk endpoint is beta, accepts 1-10 records per request, returns results in request order, and has an additional limit of 3 requests per second.

Input Parameters

array
required
Opportunities to create in order; each uses Copper’s single-opportunity create fields.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COPPER_BULK_CREATE_PEOPLEAttempt to create 1-10 Copper people and return ordered per-item successes or validation failures. This Copper bulk endpoint is beta, accepts 1-10 records per request, returns results in request order, and has an additional limit of 3 requests per second.

Input Parameters

array
required
People to create in order; each uses Copper’s single-person create fields.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COPPER_BULK_UPDATE_COMPANIESAttempt to update 1-10 Copper companies and return ordered per-item successes or validation failures. This Copper bulk endpoint is beta, accepts 1-10 records per request, returns results in request order, and has an additional limit of 3 requests per second.

Input Parameters

array
required
Companies to update in order. Each item requires its ID; omitted fields remain unchanged.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COPPER_BULK_UPDATE_LEADSUpdate 1-10 Copper leads in one beta bulk request and return ordered per-item outcomes. Copper can return HTTP 500 after applying the write; treat failures as indeterminate and read records back before retrying.

Input Parameters

array
required
Between 1 and 10 lead updates. Results preserve this ordering.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COPPER_BULK_UPDATE_PEOPLEAttempt to update 1-10 Copper people and return ordered per-item successes or validation failures. This Copper bulk endpoint is beta, accepts 1-10 records per request, returns results in request order, and has an additional limit of 3 requests per second.

Input Parameters

array
required
People to update in order. Each item requires its ID; omitted fields remain unchanged.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COPPER_CONVERT_LEADConvert a Copper lead into a person and optionally a company and opportunity; the original lead is removed.

Input Parameters

object
required
Person and optional company and opportunity conversion details.
integer
required
Copper lead ID to convert and remove.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COPPER_CREATE_ACTIVITYCreate a user-category activity such as a note on an existing Copper lead, person, company, opportunity, project, or task; system activities are read-only.

Input Parameters

object
required
Existing Copper record that will own the activity.
string
required
Activity text or note content.
integer
Activity time as Unix seconds; omit to use Copper’s default.
integer
required
ID of a user-category activity type; system activity types are read-only.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COPPER_CREATE_COMPANYCreate a Copper company with domain, contact, ownership, tag, and custom-field data.

Input Parameters

string
required
Company name.
array
Tag names to assign to the company.
object
Postal address for the company.
string
Free-form company notes.
array
Social profile URLs and their Copper categories.
array
Website URLs and their Copper categories.
integer
Copper user ID responsible for the company.
string
Unique company email domain; omit when unknown to avoid uniqueness conflicts.
array
Custom-field definition IDs and values to assign to the company.
array
Phone numbers and their Copper categories.
integer
Contact type ID for the company.
integer
Existing Copper person ID to set as primary contact.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COPPER_CREATE_CUSTOM_ACTIVITY_TYPECreate a named Copper custom activity type with a supported icon. Custom activity types cannot be deleted; retire one with UPDATE_CUSTOM_ACTIVITY_TYPE using is_disabled=true.

Input Parameters

string
required
Name of the custom activity type.
string ("Message" | "Phone" | "Event" | "Assignment" | "Assessment" | "Group" | "Description" | "Speaker Notes" | "Forum" | "Web" | "Loyalty" | "Content Paste" | "Headset" | "Share" | "Navigation" | "Notification" | "Voicemail" | "Room" | "Edit" | "Send" | "Videocam" | "Play Arrow" | "Grocery Store" | "Mic" | "Camera Mic" | "Todo")
required
Copper icon to display for this activity type.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COPPER_CREATE_CUSTOM_FIELD_DEFINITIONCreate a Copper custom field for selected record types.

Input Parameters

string
required
Name of the custom-field definition.
array
Options in display order. Required with at least one item for Dropdown and at least two items for MultiSelect.
string
Three-letter currency code for a Currency field, such as USD or CAD.
string ("Checkbox" | "Currency" | "Date" | "Dropdown" | "Float" | "MultiSelect" | "Percentage" | "String" | "Text" | "URL")
required
Copper custom-field data type.
array
Record types on which this custom field is available.
boolean
Whether this field can be used in Copper filters.
string
Unique workflow field key; Copper lowercases it when creating the field.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COPPER_CREATE_LEADCreate a Copper lead with contact, ownership, source, status, tag, and custom-field data.

Input Parameters

string
required
Full name of the lead.
array
Tag names assigned to the lead.
object
Lead’s email address and category.
string
Professional title of the lead.
object
Lead postal address.
string
Free-form lead details.
array
Lead social profiles and categories.
array
Lead websites and categories.
integer
Lead status ID from List Lead Statuses.
integer
Copper user ID assigned to the lead.
string
Lead’s company name.
array
Custom-field IDs and values to set.
array
Lead phone numbers and categories.
number
Expected monetary value of business with the lead.
integer
Customer source ID that generated the lead.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COPPER_CREATE_OPPORTUNITYCreate a Copper opportunity. Only the name is required; Copper can supply the default pipeline and stage, and the primary contact is optional.

Input Parameters

string
required
Opportunity name.
array
Tag names to assign.
string ("Open" | "Won" | "Lost" | "Abandoned")
Opportunity status.
string
Free-form opportunity notes.
string ("None" | "Low" | "Medium" | "High")
Opportunity priority.
string
Expected close date in the Copper date format configured for the account.
integer
Existing Copper company ID associated with the opportunity.
integer
Copper user ID responsible for the opportunity.
integer
Pipeline ID; resolve with COPPER_LIST_PIPELINES.
array
Custom-field definition IDs and values to assign to the opportunity.
integer
Copper loss-reason ID to assign.
string
Opportunity monetary value in the format used by the connected Copper account.
integer
Win probability percentage from 0 to 100.
integer
Stage ID belonging to pipeline_id; resolve with COPPER_LIST_PIPELINES.
integer
Copper customer-source ID to assign.
integer
Optional existing Copper person ID to use as the primary contact.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COPPER_CREATE_PERSONCreate a Copper person with contact, company, ownership, tag, and custom-field data.

Input Parameters

string
required
Full name of the person.
array
Tag names to assign.
string
Job title.
array
Email addresses and their Copper categories.
object
Postal address accepted by Copper.
string
Free-form notes about the person.
array
Social profile URLs and their Copper categories.
array
Website URLs and their Copper categories.
integer
Existing Copper company ID to associate.
integer
Copper user ID responsible for the person.
array
Custom-field definition IDs and values to set.
array
Phone numbers and their Copper categories.
integer
Contact type ID; omit to use the account default.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COPPER_CREATE_PROJECTCreate a Copper project, optionally related to another record and assigned to a user.

Input Parameters

string
required
Project name.
array
Tag names to assign to the project.
string ("Open" | "Completed")
Initial project status.
string
Free-form project notes.
integer
Copper user ID responsible for the project.
array
Custom-field definition IDs and values to assign to the project.
Copper record to relate to the project; include both its ID and singular type.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COPPER_CREATE_TASKCreate a Copper task with optional assignment, related record, due/reminder times, priority, tags, and custom fields.

Input Parameters

string
required
Task name.
array
Tag names to assign to the task.
string ("Open" | "Completed")
Initial task status.
string
Free-form task notes.
integer
Due time as 10-digit Unix seconds.
string ("None" | "Low" | "Medium" | "High")
Task priority.
integer
Copper user ID responsible for the task.
array
Custom-field definition IDs and values to assign to the task.
integer
Reminder time as 10-digit Unix seconds.
Copper record to relate to the task; include both its ID and singular type.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COPPER_DELETE_ATTACHED_FILEPermanently delete one file attached to a Copper lead, person, opportunity, company, or project.

Input Parameters

integer
required
Copper ID of the attached file.
integer
required
Copper ID of the record within entity_type.
string ("leads" | "people" | "opportunities" | "companies" | "projects")
required
Copper collection containing the record: leads, people, opportunities, companies, or projects.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COPPER_DELETE_CUSTOM_FIELD_DEFINITIONPermanently delete one Copper custom-field definition by ID.

Input Parameters

integer
required
Copper custom-field definition ID to permanently delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COPPER_DELETE_LEADPermanently delete one Copper lead by ID.

Input Parameters

integer
required
Copper lead ID to permanently delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COPPER_DELETE_RECORDDelete one Copper person, company, opportunity, project, task, or activity by type and ID. Deleting an activity is a soft delete: successful cleanup may leave it fetchable as an is_deleted=true stub rather than make it fully disappear.

Input Parameters

integer
required
Copper ID of the record to delete within record_type.
string ("people" | "companies" | "opportunities" | "projects" | "tasks" | "activities")
required
Copper collection containing the record to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COPPER_GET_ACCOUNTReturn the connected Copper account, timezone, and feature settings; use it to preflight features such as Leads.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COPPER_GET_ATTACHED_FILE_METADATAGet metadata for one file attached to a Copper lead, person, opportunity, company, or project.

Input Parameters

integer
required
Copper ID of the attached file.
integer
required
Copper ID of the record within entity_type.
string ("leads" | "people" | "opportunities" | "companies" | "projects")
required
Copper collection containing the record: leads, people, opportunities, companies, or projects.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COPPER_GET_CURRENT_USERReturn the Copper user represented by the connected account, including the user ID used for assignments.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COPPER_GET_CUSTOM_ACTIVITY_TYPEReturn one Copper custom activity type’s name, icon, enabled state, interaction behavior, and ownership metadata by ID.

Input Parameters

integer
required
Copper custom activity-type ID to fetch.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COPPER_GET_CUSTOM_FIELD_DEFINITIONReturn one Copper custom field’s data type, record availability, filterability, options, and currency configuration by definition ID.

Input Parameters

integer
required
Copper custom-field definition ID to fetch.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COPPER_GET_FIELD_LAYOUTReturn enabled and create/edit requiredness metadata for one Copper entity type. Opportunities require pipeline_id; other entity types do not accept it.

Input Parameters

string ("leads" | "people" | "companies" | "opportunities" | "projects" | "tasks")
required
Plural Copper entity type whose configured field layout to return.
integer
Pipeline ID, required for opportunities and unsupported for other entity types.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COPPER_GET_LEADReturn one Copper lead’s contact, ownership, source, status, tags, and custom-field data by lead ID.

Input Parameters

integer
required
Copper lead ID to fetch.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COPPER_GET_PERSON_BY_EMAILReturn the unique Copper person record matching an exact email address.

Input Parameters

string
required
Unique email address of the Copper person to fetch.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COPPER_GET_RECORDFetch one user, person, company, opportunity, project, task, or activity by its type and ID.

Input Parameters

integer
required
Copper ID of the record within record_type.
string ("users" | "people" | "companies" | "opportunities" | "projects" | "tasks" | "activities")
required
Copper collection containing the record; IDs are unique only within a type.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COPPER_LIST_ATTACHED_FILESList all files attached to one Copper lead, person, opportunity, company, or project.

Input Parameters

integer
required
Copper ID of the record within entity_type.
string ("leads" | "people" | "opportunities" | "companies" | "projects")
required
Copper collection containing the record: leads, people, opportunities, companies, or projects.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COPPER_LIST_CUSTOM_ACTIVITY_TYPESList Copper’s default user-entered activity types and account-created custom activity types; system activity types and Notes are available through LIST_REFERENCE_VALUES with activity_types.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COPPER_LIST_CUSTOM_FIELD_DEFINITIONSReturn Copper custom-field IDs, types, availability, and options needed to read, filter, and write custom field values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COPPER_LIST_ENTITY_ACTIVITIESList selected activity types related to one Copper lead, person, or company; company results may also include activities from related people.

Input Parameters

integer
required
Copper lead, person, or company ID.
string ("leads" | "people" | "companies")
required
Copper collection whose related activities to list.
array
required
Activity type IDs and categories to include.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COPPER_LIST_LEAD_STATUSESList Copper lead status IDs, names, display order, and default selection for use in lead writes and searches.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COPPER_LIST_PIPELINESReturn all configured Copper pipelines with their stages and win probabilities for opportunity creation and updates.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COPPER_LIST_PIPELINE_STAGESList Copper opportunity stages for one pipeline, or list stages across pipelines when no pipeline ID is supplied. Each stage includes its pipeline ID and win probability.

Input Parameters

integer
Copper pipeline ID whose ordered stages to return; omit to list stages across all pipelines.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COPPER_LIST_REFERENCE_VALUESList one bounded set of Copper IDs used in write schemas: activity types, customer sources, contact types, or opportunity loss reasons.

Input Parameters

string ("activity_types" | "customer_sources" | "contact_types" | "loss_reasons")
required
Reference collection to list. For activity_types, user and system categories are preserved; only user types are valid for writes.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COPPER_LIST_TAGSReturn one alphabetical page of Copper tag names for filtering or assigning records.

Input Parameters

string
Opaque continuation cursor returned by the previous call; omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COPPER_LIST_USERSReturn one page of Copper users for resolving assignee and owner IDs.

Input Parameters

integer
Maximum users to return in this page (1-200).
string
Opaque cursor returned by the previous call; omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COPPER_RELATE_RECORDSCreate a direct relationship between two existing Copper records, preserving both record types and IDs.

Input Parameters

integer
required
Copper ID of the source record within entity_type.
string ("leads" | "people" | "companies" | "opportunities" | "projects" | "tasks")
required
Plural Copper source collection token: leads, people, companies, opportunities, projects, or tasks.
Copper ID of the existing related record within related_record_type.
Singular Copper target type. Allowed by source: leads to task; people to company, opportunity, task, or project; companies and opportunities to person, task, project, or each other; projects to company, person, opportunity, or task; tasks to company, person, opportunity, lead, or project.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COPPER_SEARCH_ACTIVITIESSearch Copper activities globally or for one parent record by activity type and date range, returning one page.

Input Parameters

object
Parent record whose activities to return; omit to search globally.
integer
Maximum activities to return in this page (1-200).
boolean
Set true only as an administrator timeout workaround; Copper may then return duplicate email activities.
string
Opaque cursor returned by the previous call; omit for the first page.
array
Activity type IDs and categories to match.
integer
Latest activity time to include, as Unix seconds.
integer
Earliest activity time to include, as Unix seconds.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COPPER_SEARCH_COMPANIESSearch Copper companies by name, domain, ownership, contact type, location, date, or custom-field criteria and return one page.

Input Parameters

object
Optional company filters for name, domain, ownership, contact type, location, date, social, or custom-field criteria.
string ("name" | "phone" | "contact" | "contact_first_name" | "contact_last_name" | "date_modified" | "date_created" | "email_domain" | "city" | "state" | "country" | "zip" | "assignee" | "contact_group" | "last_interaction" | "interaction_count" | "primary_website" | "socials")
Company field used for stable ordering.
integer
Maximum companies to return in this page (1-200).
string
Opaque cursor returned by the previous call; omit for the first page. The cursor retains the original filters and ordering.
string ("asc" | "desc")
Sort direction.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COPPER_SEARCH_LEADSSearch Copper leads by identity, ownership, status, source, location, value, activity, date, tags, socials, or custom fields and return one page.

Input Parameters

object
Optional lead filters; all supplied criteria are combined with AND.
string ("name" | "company_name" | "title" | "date_modified" | "date_created" | "city" | "state" | "inactive_days")
Lead field used to sort results.
integer
Maximum leads in this page (1-200).
string
Opaque cursor from the previous call; omit for the first page.
string ("asc" | "desc")
Sort direction.
boolean
Whether converted leads are included.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COPPER_SEARCH_OPPORTUNITIESSearch Copper opportunities by pipeline, stage, status, contact, company, value, date, ownership, or custom-field criteria and return one page.

Input Parameters

object
Optional pipeline, stage, status, contact, company, value, date, ownership, tag, interaction, or custom-field filters.
string ("assignee" | "company_name" | "customer_source_id" | "date_created" | "date_modified" | "inactive_days" | "interaction_count" | "last_interaction" | "monetary_unit" | "monetary_value" | "name" | "primary_contact" | "priority" | "stage" | "status")
Opportunity field used for stable ordering.
integer
Maximum opportunities to return in this page (1-200).
string
Opaque cursor returned by the previous call; omit for the first page.
string ("asc" | "desc")
Sort direction.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COPPER_SEARCH_PEOPLESearch Copper people by contact, company, ownership, tag, date, or custom-field criteria and return one page.

Input Parameters

object
Optional person filters for contact, company, ownership, tag, date, address, interaction, or custom-field criteria.
string ("name" | "title" | "email" | "phone" | "date_modified" | "date_created" | "city" | "state" | "country" | "zip" | "socials")
Person field used for stable ordering.
integer
Maximum people to return in this page (1-200).
string
Opaque cursor returned by the previous call; omit for the first page. The cursor retains the original filters and ordering.
string ("asc" | "desc")
Sort direction.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COPPER_SEARCH_PROJECTSSearch Copper projects by name, owner, tag, status, or custom-field criteria and return one page.

Input Parameters

object
Optional project filters for name, owner, tags, status, or custom fields.
string ("name" | "assigned_to" | "related_to" | "status" | "date_modified" | "date_created")
Project field used for stable ordering.
integer
Maximum projects to return in this page (1-200).
string
Opaque cursor returned by the previous call; omit for the first page.
string ("asc" | "desc")
Sort direction.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COPPER_SEARCH_TASKSSearch Copper tasks by name, owner, tag, related project or opportunity, status, due date, or custom-field criteria and return one page.

Input Parameters

object
Optional task filters for name, owner, tag, followed state, related project or opportunity, status, due date, or custom fields.
string ("name" | "assigned_to" | "related_to" | "status" | "priority" | "due_date" | "reminder_date" | "completed_date" | "date_created" | "date_modified")
Task field used for stable ordering.
integer
Maximum tasks to return in this page (1-200).
string
Opaque cursor returned by the previous call; omit for the first page.
string ("asc" | "desc")
Sort direction.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COPPER_UNRELATE_RECORDSRemove a direct relationship between two existing Copper records without deleting either record.

Input Parameters

integer
required
Copper ID of the source record within entity_type.
string ("leads" | "people" | "companies" | "opportunities" | "projects" | "tasks")
required
Plural Copper source collection token: leads, people, companies, opportunities, projects, or tasks.
Copper ID of the related record within related_record_type.
Singular Copper target type to unrelate. Allowed by source: leads to task; people to company, opportunity, task, or project; companies and opportunities to person, task, project, or each other; projects to company, person, opportunity, or task; tasks to company, person, opportunity, lead, or project.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COPPER_UPDATE_ACTIVITYUpdate the details, date, or both for an existing user-category Copper activity; at least one change is required, and system or deleted activities cannot be modified.

Input Parameters

string
Replacement activity text; provide details, activity_date, or both.
integer
required
Copper user-activity ID to update.
integer
Replacement activity time as Unix seconds; provide activity_date, details, or both.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COPPER_UPDATE_COMPANYUpdate selected writable fields of an existing Copper company without replacing omitted fields.

Input Parameters

object
required
One or more writable company fields. Omitted fields remain unchanged.
integer
required
Copper company ID to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COPPER_UPDATE_CUSTOM_ACTIVITY_TYPERename, change the icon, or enable or disable a Copper custom activity type. To retire a type, disable it with is_disabled=true; custom activity types cannot be deleted.

Input Parameters

string
Replacement activity-type name.
string ("Message" | "Phone" | "Event" | "Assignment" | "Assessment" | "Group" | "Description" | "Speaker Notes" | "Forum" | "Web" | "Loyalty" | "Content Paste" | "Headset" | "Share" | "Navigation" | "Notification" | "Voicemail" | "Room" | "Edit" | "Send" | "Videocam" | "Play Arrow" | "Grocery Store" | "Mic" | "Camera Mic" | "Todo")
Replacement Copper activity icon.
boolean
Set whether this custom activity type is disabled.
integer
required
Copper custom activity-type ID to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COPPER_UPDATE_CUSTOM_FIELD_DEFINITIONUpdate one Copper custom-field definition by ID.

Input Parameters

string
Replacement custom-field name.
array
Replacement options in display order. When changing data_type, provide at least one item for Dropdown or two for MultiSelect.
string
Replacement three-letter currency code for a Currency field.
string ("Checkbox" | "Currency" | "Date" | "Dropdown" | "Float" | "MultiSelect" | "Percentage" | "String" | "Text" | "URL")
Replacement Copper custom-field data type.
array
Replacement set of record types for this field.
boolean
Whether the field can be used in Copper filters.
integer
required
Copper custom-field definition ID to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COPPER_UPDATE_LEADUpdate selected fields of a Copper lead without replacing omitted fields.

Input Parameters

object
required
One or more writable lead fields; omitted fields remain unchanged and explicit null clears a field.
integer
required
Copper lead ID to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COPPER_UPDATE_OPPORTUNITYUpdate selected writable fields of an existing Copper opportunity without replacing omitted fields.

Input Parameters

object
required
One or more writable opportunity fields. Omitted fields remain unchanged.
integer
required
Copper opportunity ID to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COPPER_UPDATE_PERSONUpdate selected writable fields of an existing Copper person without replacing omitted fields.

Input Parameters

object
required
One or more writable person fields. Omitted fields remain unchanged.
integer
required
Copper person ID to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COPPER_UPDATE_PROJECTUpdate selected writable fields of an existing Copper project without replacing omitted fields.

Input Parameters

object
required
One or more writable project fields. Omitted fields remain unchanged.
integer
required
Copper project ID to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COPPER_UPDATE_TASKUpdate selected writable fields of an existing Copper task without replacing omitted fields.

Input Parameters

object
required
One or more writable task fields. Omitted fields remain unchanged. completed_date is server-managed and cannot be updated.
integer
required
Copper task ID to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COPPER_UPLOAD_ATTACHED_FILEGet upload authorization from Copper, upload up to 20 MB of file bytes to Copper’s fixed Amazon S3 bucket, and attach the uploaded key to one Copper lead, person, opportunity, company, or project. If a failure occurs after the S3 upload starts, the file may already be uploaded or attached; verify the record before retrying to avoid duplicate attachments.

Input Parameters

object
required
File to upload and attach, up to 20 MB. Its name becomes the displayed Copper file name.
integer
required
Copper ID of the record within entity_type.
string ("leads" | "people" | "opportunities" | "companies" | "projects")
required
Copper collection containing the record: leads, people, opportunities, companies, or projects.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COPPER_UPSERT_LEADCreate or update a Copper lead by exact name, email, or custom-field match. Copper resolves matches through a search index that can lag recent writes by seconds, so upserting a just-created lead may insert a duplicate; wait and verify before retrying. Copper rejects ambiguous matches.

Input Parameters

string
required
Name, email, or custom-field match criterion.
object
required
Lead properties used to create a new lead or update the single match.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not