Skip to main content

​
What can you do with it?

The Copper CRM integration enables you to manage your complete customer relationship workflow including leads, people, companies, opportunities, projects, tasks, and activities. You can create new records, update existing information, search across all record types, and manage custom fields. This integration is perfect for teams looking to streamline their sales processes and maintain organized customer data with full CRUD operations across all Copper CRM entities.

​
How to use it?

​
Basic Command Structure

/your-copper-connection [action] [required-parameters] [optional-parameters]

​
Parameters

Required:
  • action - The operation you want to perform (create, update, get, search, delete)
  • record_type - The type of record (leads, people, companies, opportunities, projects, tasks, activities)
Optional:
  • custom_fields - Custom field values for your organization
  • sort_by - Field to sort search results by

​
Tools

​
Create Record

Create a new record in Copper CRM Parameters:
  • record_type (required) - Type of record to create (leads, people, companies, opportunities, projects, tasks, activities)
  • name (required) - Name of the record
  • email (optional) - Email address with category (work, personal, etc.)
  • phone_numbers (optional) - Array of phone numbers with categories
  • address (optional) - Physical address details
  • customer_source_id (optional) - Source tracking ID
  • custom_fields (optional) - Array of custom field values
Example: 
/your-copper-connection
action: create
record_type: leads
name: Acme Corporation
email: [email protected]
email_category: work
phone: +1234567890
phone_category: work
street: 123 Main St
city: Anytown
state: CA
postal_code: 12345
country: USA
Response: 
{
  "id": "[Created record ID]",
  "name": "[Record name]",
  "date_created": "[Creation timestamp]"
}

​
Update Record

Update an existing record in Copper CRM Parameters:
  • record_type (required) - Type of record to update
  • id (required) - The unique ID of the record
  • name (optional) - Updated name
  • phone_numbers (optional) - Updated phone numbers
  • email (optional) - Updated email
  • custom_fields (optional) - Updated custom field values
Example: 
/your-copper-connection
action: update
record_type: people
id: 123456
name: John Doe
phone: +0987654321
phone_category: mobile
Response: 
{
  "id": "[Record ID]",
  "name": "[Updated name]",
  "date_modified": "[Modification timestamp]"
}

​
Get Record by ID

Retrieve a specific record using its unique ID Parameters:
  • record_type (required) - Type of record to retrieve
  • id (required) - The unique ID of the record
Example: 
/your-copper-connection
action: get
record_type: companies
id: 123456
Response: 
{
  "id": "[Record ID]",
  "name": "[Record name]",
  "date_created": "[Creation timestamp]",
  "[additional_fields]": "[Record details]"
}

​
Search Records

Search for records based on various criteria Parameters:
  • record_type (required) - Type of records to search
  • name (optional) - Name to search for
  • page_size (optional) - Number of results per page (default: 25)
  • sort_by (optional) - Field to sort by
  • custom_fields (optional) - Search by custom field values
Example: 
/your-copper-connection
action: search
record_type: opportunities
name: Acme Deal
page_size: 25
sort_by: name
Response: 
{
  "results": "[Array of matching records]",
  "count": "[Number of results]"
}

​
Delete Record

Delete a specific record from Copper CRM Parameters:
  • record_type (required) - Type of record to delete
  • id (required) - The unique ID of the record
Example: 
/your-copper-connection
action: delete
record_type: projects
id: 123456
Response: 
{
  "message": "Record deleted successfully."
}

​
Search by Custom Field

Search for records using custom field filters Parameters:
  • record_type (required) - Type of records to search
  • custom_field_id (required) - Custom field definition ID
  • custom_field_value (required) - Value to search for
Example: 
/your-copper-connection
action: search_custom
record_type: leads
custom_field_id: 1001
custom_field_value: Custom Value
Response: 
{
  "results": "[Array of records matching custom field criteria]",
  "count": "[Number of results]"
}

​
Notes

Copper CRM uses Unix timestamps for date fields. Phone numbers and emails can have categories such as work, personal, or mobile. Custom fields require the custom_field_definition_id which is specific to your Copper instance. The record_type parameter accepts leads, people, companies, opportunities, projects, tasks, or activities. When creating or updating records with addresses, all address fields (street, city, state, postal_code, country) should be provided together.