Lead Capture API Entry Points¶

Overview¶

The Mythradon Lead Capture API Entry Points provide a robust, secure, and flexible way to collect and manage lead information from various external sources. Designed to seamlessly integrate with your existing marketing channels and web forms, these API entry points enable automated lead submission, ensuring that prospect data is accurately captured and routed into your Mythradon system in real time.

Key features include:

Standardised Data Capture: Accepts essential lead details such as first name, last name, email, phone, and custom fields.
Real-Time Processing: Instantly creates or updates lead records, allowing your sales team to engage prospects faster.
Error Handling and Validation: Ensures submitted data meets required formats and provides detailed feedback on submission status.
Security: Implements authentication protocols and rate limiting to protect against unauthorized access and abuse.

Whether you're integrating lead capture forms on your website, landing pages, or third-party platforms, the Mythradon Lead Capture API Endpoints streamline the process of converting visitors into actionable leads.

Create a Lead Capture Entry Point¶

To begin capturing leads via API, follow these steps:

Navigate to Administration → Lead Capture from the Menu Button.
Click the Create Entry Point button.
Configure the required settings for your entry point, then click Save. Refer to the Properties Table below for detailed descriptions of each field.

Multiple Lead Capture Entry Points

You can create multiple Lead Capture Entry Points, each with unique configurations tailored to different campaigns, sources, or workflows. There is no limit to the number of entry points you may use.

Create Entry Point - Light Create Entry Point - Dark

Lead Capture Entry Point Properties¶

Property	Description
Name	A descriptive, user-friendly name to identify this entry point within your system.
Is Active	Toggle to enable or disable this entry point. By default, new entry points are active.
Subscribe to Target List	Select a Target List to which new leads submitted through this entry point will be automatically added.
Subscribe Contact if Exists	If the incoming lead matches an existing Contact and this option is enabled, that Contact will be added to the Target List.
Campaign	Link new leads to a specific Marketing Campaign. All activity from these leads will be tracked within this campaign.
Target Team	Designate a Team responsible for managing or following up with leads captured through this entry point.
Lead Source	Identify the origin of leads (e.g., Website, Email, Phone Call) to help categorise incoming data.
Payload Fields	Define the expected data fields in the API payload, ensuring proper mapping of submitted information.
Duplicate Check	Enable automatic detection to prevent creating duplicate leads if matching records exist.
Double Opt-In	Require leads to confirm their subscription via email to verify consent before activation.
Create Lead Before Confirmation	Choose whether to create a lead record immediately upon submission or only after opt-in confirmation.
Skip Confirmation if Lead Already in Target List	Automatically bypass opt-in confirmation for leads already subscribed.
Opt-In Confirmation Email Template	Select the email template used to send the double opt-in confirmation request.
Opt-In Confirmation Lifetime (hours)	Set the validity period of the confirmation link sent via email.
SMTP Account	Specify which SMTP account will be used to send opt-in confirmation emails.
Post-Confirmation Message	Custom text displayed to leads after successful opt-in confirmation.

Double Opt-In

See the Double Opt-In section below for more information about managing lead consent and confirmation workflows.

After saving your Entry Point, you can view detailed information on the right-hand panel, including:

Entry Point View - Light Entry Point View - Dark

Property	Description
URL	The unique URL entry point to which lead data should be posted.
Method	The HTTP method supported (e.g., POST).
Payload	The format and fields expected in the API payload.

You can now integrate this Lead Capture API Entry Point with your website, landing pages, or other applications to automatically capture leads.

Double Opt-In¶

When enabled, Double Opt-In requires new subscribers to verify their email address by clicking a confirmation link sent automatically after lead submission. This process ensures compliance with privacy regulations and confirms user consent.

Available Email Template Placeholders¶

Your double opt-in email templates can include the following placeholders to personalize and automate content:

Placeholder	Description
`{optInUrl}`	The full confirmation URL containing a unique ID for opt-in verification.
`{optInLink}`	A clickable link labeled "Confirm Opt-In" directing to `{optInUrl}`.
`{optInDate}`	The date the subscription request was received (e.g., 11/10/2023).
`{optInTime}`	The time the subscription request was received (e.g., 08:27).
`{optInDateTime}`	The combined date and time of the subscription request (e.g., 11/10/2023 08:27).

Note

If your template does not explicitly include a placeholder, a default confirmation link will be appended automatically.

Sample Double Opt-In Email Template¶

Dear {Lead.firstName},

Thank you for your interest in joining our community at Mythradon. To ensure we have the correct email and your consent, please confirm your subscription by clicking the link below:

{optInLink}

By confirming, you'll stay updated with the latest news, offers, and valuable content from Mythradon.

If you did not sign up for this, you can safely ignore this email and will not receive further communications.

Warm regards,  
The Mythradon Team

Privacy Policy | Contact Us

For additional guidance, see Email Templates.

Sample Web-to-Lead Form¶

For a practical example of a fully functional Web-to-Lead form compatible with Mythradon, see the Web-to-Lead Sample Form.

Web-to-Lead Log¶

Every Lead Capture Entry Point maintains a detailed submission log for monitoring and troubleshooting incoming leads. This log is accessible within the Entry Point details under the related list section.

Entry Point View Log List - Light Entry Point View Log List - Dark

The log records each submission's outcome, including:

Successfully created leads
Submissions identified as duplicates (linked to existing Contacts)

Clicking the lead/contact name in the log takes you directly to their detailed record for quick follow-up.