Skip to main content

​
What can you do with it?

The Close CRM integration enables you to manage your complete sales workflow including leads, contacts, opportunities, and activities. You can create new records with contact information, update existing data, search across all record types using both simple queries and advanced JSON filters, and manage custom fields. This integration is ideal for sales teams focused on relationship building and deal tracking with comprehensive contact management capabilities.

​
How to use it?

​
Basic Command Structure

/your-close-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 (lead, contact, opportunity, activity)
Optional:
  • query - Search query for finding records
  • custom_fields - Custom field values specific to your Close CRM setup

​
Tools

​
Create Record

Create a new record in Close CRM Parameters:
  • record_type (required) - Type of record to create (lead, contact, opportunity, activity)
  • name (required) - Name of the record
  • contact_name (optional) - Name of associated contact
  • emails (optional) - Array of email addresses
  • phones (optional) - Array of phone numbers
  • custom_fields (optional) - Custom field values
Example: 
/your-close-connection
action: create
record_type: lead
name: Acme Corporation
contact_name: John Doe
email: [email protected]
phone: +1234567890
Response: 
{
  "id": "[Created record ID]",
  "name": "[Record name]",
  "date_created": "[Creation timestamp]"
}

​
Update Record

Update an existing record in Close CRM Parameters:
  • record_type (required) - Type of record to update
  • id (required) - The unique ID of the record
  • name (optional) - Updated name
  • phones (optional) - Updated phone numbers
  • emails (optional) - Updated email addresses
  • custom_fields (optional) - Updated custom field values
Example: 
/your-close-connection
action: update
record_type: contact
id: contact_abc123
name: Jane Doe
phone: +0987654321
Response: 
{
  "id": "[Record ID]",
  "name": "[Updated name]",
  "date_updated": "[Update 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-close-connection
action: get
record_type: lead
id: lead_abc123
Response: 
{
  "id": "[Record ID]",
  "name": "[Record name]",
  "date_created": "[Creation timestamp]",
  "[additional_fields]": "[Record details]"
}

​
Search Records

Search for records using a simple query Parameters:
  • record_type (required) - Type of records to search
  • query (required) - Search query string
Example: 
/your-close-connection
action: search
record_type: lead
query: Acme
Response: 
{
  "data": "[Array of matching records]",
  "total_results": "[Number of results]"
}

​
Delete Record

Delete a specific record from Close CRM Parameters:
  • record_type (required) - Type of record to delete
  • id (required) - The unique ID of the record
Example: 
/your-close-connection
action: delete
record_type: opportunity
id: opportunity_abc123
Response: 
{
  "message": "Record deleted successfully."
}
Search for records using advanced JSON filters Parameters:
  • record_type (required) - Type of records to search
  • filter_field (required) - Field to filter on
  • filter_value (required) - Value to search for
Example: 
/your-close-connection
action: advanced_search
record_type: contact
filter_field: emails.email
filter_value: [email protected]
Response: 
{
  "data": "[Array of records matching filter criteria]",
  "total_results": "[Number of results]"
}

​
Notes

Close CRM uses string-based IDs with prefixes like “lead_”, “contact_”, “opportunity_”, etc. Contact information is stored as arrays - emails and phones can have multiple entries per record. Custom fields use the format “cf_custom_field_id” and values are specific to your Close CRM configuration. Advanced search supports nested field queries like “emails.email” for searching within contact email arrays. Record creation for leads can include embedded contact information in a single request.