Our Leads API enables you to integrate your CRM with the Remedly system, making it simple to transfer your leads. This integration saves time by eliminating the need for manual entry and reducing data error risk.
In this article, you'll learn:
What is a CRM?
CRM stands for Customer Relationship Management. It's software that helps businesses organize and manage interactions with their current and potential customers (leads). Your CRM stores information like contact details, communications, and other customer-related data.
How to Enroll Your Practice for Remedly Leads API
Remedly's Leads API follows the OpenAPI standard and employs OAuth2 protocol for authentication. To integrate your CRM with Remedly, start by enrolling your practice in the Remedly system. Contact support@remedly.com to receive credentials for API call authentication:
- client_id
- client_secret
Next, configure specific rules in your CRM according to which calls from your CRM to the Remedly Leads API will be made to ensure successful lead transfer.
IMPORTANT: Currently, updates to leads in your CRM cannot be synced to Remedly for leads that have already been transferred. Therefore, we encourage you to make any updates to these previously imported leads directly in Remedly.
Implementation of Webhook
If your CRM only supports Webhook integration and does not support OAuth2 authentication type, Remedly can configure Webhooks which are supported by your CRM. To proceed, please contact support@remedly.com and provide the name of your CRM. Be ready to grant us access to your CRM so we can configure the webhook(s). There’s a fee for the webhook setup.
How our Lead API Works
Once you’ve enrolled for Remedly Leads API, your CRM can be configured to connect to the Remedly Leads API. Here’s how the API handles incoming lead data from your CRM:
Main Important Fields:
-
First Name, Last Name, Email, and/or Phone Number are required for leads to be added to Remedly.
- If First Name or Last Name is missing, the system will use the phone number or part of the email to fill in those fields.
- If both a phone number and email are missing, the lead won’t be added (Lead with Missing Data).
- If a lead contains an invalid phone number and/or email, this lead will be pulled to Remedly. However, the invalid phone number and/or email will be populated into the Notes field of a lead.
Optional Fields:
- Birthday, Country, State (if in the US), and Zip Code are optional fields. If these fields are in the wrong format, they will be added to the Notes section of the lead.
Additional Data:
Any other data, such as Referral Sources or Treatments, will also be added to the Notes section of the lead summary in plain text.
How the Remedly Leads API Validates Incoming Leads
1. Validation of Incoming Leads
Before leads are added to Remedly, the system checks if they already exist by comparing phone numbers and emails in our database. This ensures no duplicates are created.
- If the lead already exists in the Current Leads (including archived leads) or Patient Chart based on their phone number or email, it won’t be added again.
- We validate phone numbers across all types (cell, home, work) to prevent duplicates.
2. Validation of Lead Cell Phone Numbers
To ensure a consistent and accurate import of leads from your CRM, we apply the following validation rules for phone numbers:
2.1. Incoming country value is US and CA in your CRM:
Only 10-digit numbers should be imported into the CellPhone field.
If the number includes a +1 prefix, spaces, parentheses (), or dashes/hyphens -, these extra characters will be removed to ensure successful import.
If the cleaned number is still invalid (e.g., less than 10 digits), it will be pulled into the Notes field instead.
2.2. Countries matching Remedly's catalog or country as a NULL value (Non-US/CA) in your CRM:
Phone numbers will be imported into the CellPhone field only if they follow the international format: start with a + and contain 8-15 digits.
Spaces, parentheses (), and dashes/hyphens - will be removed to ensure successful import.
If the number remains invalid after cleaning, it will be pulled into the Notes field.
2.3. Incoming Country Values from your CRM DO NOT match Remedly's catalog:
If the incoming country does not match any value in Remedly, we will import both the country and phone number into the Notes field.
Integrating your CRM with Remedly through the Leads API simplifies your workflow by automatically pulling in lead data. This reduces manual work and keeps your leads organized and up to date in Remedly.
If you have any questions or need further assistance, feel free to reach out to our support team at support@remedly.com!