Efficient lead management is essential for business growth. ClubReady’s Add Lead API lets you automate adding prospects from external forms or apps with a simple HTTPS POST request. By integrating this API into your website, you can automatically collect and enter key prospect details, like names, emails, and phone numbers, directly into ClubReady. With basic HTML knowledge, you can set up a lead capture form that connects to the system. The Add Lead API supports both adding new leads and updating existing ones. By specifying POST variables, you can accurately categorize leads and capture important details, such as prospect type and referral information.
This article explains how to set up and use the Add Lead API, covering data entry, duplicate management, and everything you need for a smooth integration.
Please Note:
- The Add Lead API page is located under the Setup tab and within the Misc. Setup section.
- Knowledge of HyperText Markup Language (HTML) will be helpful in utilizing the contents of this page.
Content:
API Tab
You can use an API to automatically add prospects (leads) from an external form or application by sending an HTTPS POST request. The required API fields and their response codes are listed below. Some fields are required, while others are optional.
Please Note:
- This API can also update an existing user's record, either by providing the ClubReady UserID or, if a match is found based on name, email, barcode, or pincode, the existing record will be updated.
- Make sure the API is enabled before you start using it:
- The Prospect Type, Welcome Email, and Free Package variables offer the ability to select specific options that have been configured within the ClubReady dashboard. If a type is selected, the site will automatically save; you are limited to one type at a time.
To incorporate a form into your website by copying and pasting HTML, please refer to the following link: https://www.clubready.com/admin/api/adduserapi.asp. Configure the API functionality below by utilizing the POST Variable and POST Details (below), and ensure that the API integration is enabled.
The page provides four columns:
Label: The label identifies the POST Variable and helps connect it to its location or purpose within the ClubReady dashboard.
POST Variable: Also known as the 'POST request', is the value you will copy and paste into your (builder) URL.
Required?: Mandatory or Optional, this column indicates whether the POST variable must be completed when utilized in your lead form.
NOTE: Some features labeled as "optional" are, in practice, essential for ensuring the page is highly user-friendly for the club. Specifically, automations will not trigger for clients or leads unless a prospect type is assigned. Additionally, there are limitations on contacts if neither a phone number nor an email address is collected. These constraints are also influenced by how locations or corporate entities configure information gathering, such as through the use of referral codes or other available options.
POST Details: This column describes what the POST Variable will ascertain from your customer if utilized in your lead form.
API Response
The API Responses indicate that only numerical strings are permitted, while any alphabetic characters are automatically excluded.
Widget Tab
If you wish to incorporate HTML into your website to capture prospects directly into ClubReady, please use the HTML provided below. This code will generate a form on your site containing select API fields. Please ensure that the API is configured appropriately using the API variable menu tab.
Please Note:
- The form verifies that all required fields are completed and ensures that any email addresses provided are valid.
-
The form is designed to prevent duplicate entries from being submitted to the database.
- NOTE: This feature relies on how the similar user settings are configured. Choosing more options in these settings can make it more likely for a duplicate user to be created. For instance, if you select all available options, the chances of creating a duplicate user increase.
- The form also includes a comments field; any comments entered will be recorded in the prospect's notes.
- The form includes a 'coupon code' field, allowing you to track whether the respondent originated from a promotional campaign.
- The contact method for the prospect will be automatically designated as 'web'.
Optional Return Page On Your Site: The ability to display a personalized message page after a customer clicks the 'Send!' button; the URL of a page on your website that displays ''Thanks - we'll be in touch''.
NOTE: If this is left blank then the form will be replaced by a generic thank you message upon submission.
Terms of Service / Privacy Policy URL: The opportunity to input your own, customized Terms of Service and Privacy Policy URL.
Include Referral Type List?: Select 'Yes' to display your configured referral types through the Referral Types and Marketing Campaigns page for the "How Did You Hear About Us?" section during lead creation. Select 'No' if you do not require a referral type selected.
Save Phone to which field?: When a customer provides a phone number, this distinction will indicate to ClubReady which field within the customer's profile should be updated: either the Cell Phone or Home Phone line.
Send The Club A Notification Email To: Ability to include staff in the Notification When A New Prospect Is Added list through the Internal Distribution List page.
You can preview your configured results with the following portion of the link: