API Reference
Welcome to the Eazy CRM API documentation. This guide will help you integrate your applications with our powerful CRM platform.
What is an API?
An API (Application Programming Interface) is a set of rules and protocols that allows different software applications to communicate with each other. It defines the methods and data formats that applications can use to request and exchange information.
How it Works
When you use an API, your application sends a request to a server, which then processes the request and returns a response. This allows you to access data and functionality from other applications without having to know how they are implemented.
Where and How to Use It
You can use the Eazy CRM API to integrate your own applications, such as websites, mobile apps, or backend services, with our CRM platform. This allows you to automate workflows, sync data, and extend the functionality of your CRM.
Use Cases with Eazy CRM
- Automatically add new leads from your website's contact form.
- Sync customer data between your e-commerce store and your CRM.
- Create custom reports and dashboards with data from your CRM.
- Integrate with third-party services, such as marketing automation or customer support platforms.
Authentication
To authenticate your requests, you need to include your API key in the request body. You can obtain your API key from your Eazy CRM dashboard.
{
"apiKey": "YOUR_API_KEY"
}
Endpoints
Add Lead to Eazy CRM
This endpoint allows you to add a note to a lead in your CRM.
Request Body
apiKey
(string, required) - Your API key.email
(string, optional) - The email address of the lead.note
(string, optional) - The content of the note.firstName
(string, required) - The first name of the lead.lastName
(string, required) - The last name of the lead.source
(string, optional) - The source of the lead.
Examples
cURL
curl -X POST https://app.eazy-crm.com/api/leads/note \
-H "Content-Type: application/json" \
-d '{
"apiKey": "YOUR_API_KEY",
"email": "lead@example.com",
"note": "Meeting scheduled for tomorrow",
"firstName": "John",
"lastName": "Doe",
"source": "API"
}'
JavaScript
const response = await fetch('https://app.eazy-crm.com/api/leads/note', {
method: 'POST',
headers: {
'Content-Type': 'application/json',
},
body: JSON.stringify({
apiKey: 'YOUR_API_KEY',
email: 'lead@example.com',
note: 'Meeting scheduled for tomorrow',
firstName: 'John',
lastName: 'Doe',
source: 'API'
})
});
const result = await response.json();