The /copper-crm command enables you to manage customer relationships and sales operations with Copper CRM. Perfect for:

• Managing leads and contacts
• Tracking opportunities
• Organizing companies
• Managing projects and tasks
• Recording activities

​

Basic Usage

Use the command to interact with Copper CRM:

/copper-crm create lead "Acme Corporation" with email "contact@acme.com"

/copper-crm search opportunities containing "Acme Deal"

/copper-crm update person 123456 with phone "+0987654321"

​

Key Features

​

Record Management

• Create new records
• Update existing records
• Delete records
• Retrieve by ID
• Bulk operations

​

Search Capabilities

• Text-based search
• Custom field filtering
• Multiple record types
• Advanced queries
• Pagination support

​

Record Types

• Leads
• People (contacts)
• Companies
• Opportunities
• Projects
• Tasks
• Activities

​

Data Organization

• Custom fields
• Categories
• Customer sources
• Address management
• Contact information

​

Example Commands

​

Create Lead

/copper-crm create lead "New Company" with email "info@newcompany.com" and phone "+1234567890"

​

Search Opportunities

/copper-crm search opportunities by name "Enterprise Deal"

​

Update Contact

/copper-crm update person 123456 with new mobile number "+0987654321"

​

Get Company Details

/copper-crm get company 123456 with full details

​

Delete Project

/copper-crm delete project 123456

​

Search by Custom Field

/copper-crm find leads where custom field 1001 equals "Premium Customer"

​

Record Structure

​

Basic Properties

• id: Unique record identifier
• name: Record name/title
• date_created: Creation timestamp
• date_modified: Last update timestamp

​

Contact Information

• email: Email addresses with categories
• phone_numbers: Phone numbers with types
• address: Physical address details
• website: Company website

​

Custom Fields

• custom_field_definition_id: Field identifier
• value: Field value
• category: Field category

​

Lead Management

​

Lead Properties

• name: Lead/company name
• email: Primary contact email
• phone_numbers: Contact numbers
• address: Business address
• customer_source_id: Lead source

​

Lead Lifecycle

1. Create lead record
2. Qualify and research
3. Convert to opportunity
4. Track through pipeline
5. Close or archive

​

Contact Management

​

Person Records

• name: Contact name
• email: Email addresses
• phone_numbers: Phone contacts
• company_id: Associated company
• title: Job title

​

Company Records

• name: Company name
• address: Business address
• phone_numbers: Main numbers
• website: Company website
• industry: Business sector

​

Opportunity Tracking

​

Opportunity Properties

• name: Deal name
• value: Deal value
• stage: Pipeline stage
• close_date: Expected close
• probability: Win probability

​

Pipeline Management

• Track deal progression
• Update stages
• Monitor forecasts
• Analyze performance

​

Search Operations

​

Basic Search

/copper-crm search leads by name "Technology"

​

Advanced Filtering

• Custom field values
• Date ranges
• Multiple criteria
• Sort options

​

Search Parameters

• page_size: Results per page
• sort_by: Sort field
• name: Name filter
• custom_fields: Custom criteria

​

Contact Information

​

Email Structure

{
  "email": "contact@company.com",
  "category": "work" // work, home, other
}

​

Phone Structure

{
  "number": "+1234567890",
  "category": "work" // work, mobile, home, fax, other
}

​

Address Structure

{
  "street": "123 Main St",
  "city": "Anytown",
  "state": "CA",
  "postal_code": "12345",
  "country": "USA"
}

​

Custom Fields

​

Field Types

• Text fields
• Number fields
• Date fields
• Dropdown selections
• Boolean flags

​

Usage

• Store additional data
• Track custom metrics
• Segment records
• Filter searches

​

Project Management

​

Project Properties

• name: Project title
• description: Project details
• status: Current status
• assignee_id: Assigned user
• due_date: Completion date

​

Task Management

• Create project tasks
• Assign responsibilities
• Track progress
• Set deadlines

​

Activity Tracking

​

Activity Types

• Calls
• Emails
• Meetings
• Notes
• Custom activities

​

Activity Properties

• type: Activity type
• details: Activity description
• date: Activity date
• user_id: Responsible user

​

Best Practices

1. Data Quality

   • Use consistent naming
   • Complete all relevant fields
   • Maintain accurate contact info
   • Regular data cleanup

2. Search Optimization

   • Use specific criteria
   • Leverage custom fields
   • Implement pagination
   • Sort results appropriately

3. Record Organization

   • Categorize contacts properly
   • Use custom fields effectively
   • Link related records
   • Maintain relationships

4. Pipeline Management

   • Update opportunity stages
   • Track deal values
   • Monitor close dates
   • Analyze win rates

​

Response Handling

​

Success Responses

• 201: Record created
• 200: Record updated/retrieved
• 204: Record deleted

​

Error Handling

• Validate required fields
• Check permissions
• Handle rate limits
• Manage API errors

​

Tips

• Use descriptive record names for easy identification
• Leverage custom fields for industry-specific data
• Maintain consistent contact categorization
• Regular backup and sync of important data
• Monitor API usage and rate limits