Integrating Lead Capture Forms with SugarCRM
August 27, 2024
Jerry Clark
Capturing leads visiting your website is often one of the most critical pipelines for potential business. Sugar provides a variety of options for accepting lead data to accommodate the easiest and most complex needs.
Option 1: POST /rest/v10/Leads/register
This is an unauthenticated REST endpoint that accepts a JSON payload. Please note that this endpoint is designed to only work with a specific set of fields. The following fields are accepted:
- first_name
- last_name
- phone_work
- primary_address_country
- primary_address_state
- account_name
- title
If additional fields are needed, you can explore the other options below.
Option 2: POST /index.php?entryPoint=WebToLeadCapture
This is an unauthenticated entry point that accepts a 'formdata' submission, usually from a webform, but we can certainly take advantage of this feature. You'll need to first create a webform within SugarCRM. You don't have to add every single field to the form unless you plan to use the form generated by Sugar. After creating the form, you'll need to find the campaign_id GUID from the HTML form. Most fields will match the database field names you see in the studio, with a few exceptions for special field types like related fields.
Option 3: POST /rest/v10/Leads
If using an authenticated endpoint is an option, POST /rest/v10/Leads is a great choice. This is similar to the POST /rest/v10/Leads/register, however, it supports any field you would like to pass to it. To authenticate, use the POST /rest/v10/oauth2/token endpoint to retrieve an access token. It's important to note that you should also register a custom platform in Admin > Configure API Platforms to avoid login conflicts. Once you have the access token, you will pass it as the OAuth-Token header to the POST /rest/v10/Leads endpoint along with your data. Be sure to store all credentials and access tokens securely.
More information about the Sugar REST APIs can be found here.
Option 4: Custom Endpoints
Create a custom endpoint, either authenticated or unauthenticated, to accept any data you wish to pass. This allows for additional processing or manipulation of the data as needed, giving you more flexibility.
If you need an expert to help implement your desired lead capture solution, contact us today!
Postman Collection
Download the postman collection to get started.
Are you new to Sugar? Start a free trial today.
Please follow us on social media or subscribe to our RSS feed to keep up-to-date on new blog posts and announcements:
To read more about our company and services, please visit our home page.