DocumentationAPI ReferenceChangelog
Log In
Documentation

Leads Management

Search or filter your list of leads and generate post-purchase email campaigns. Copy a lead token URLs to share with customers.

Interacting with the Leads List

You can use the Merchant Portal to search and filter the leads records in your store.

📘

Note

You will only be able to search for leads after your first lead has been generated. To generate leads, integrate with Extend's Orders API or the Leads API.

You can use the search bar at the top of the Leads List View to search your leads by Customer Email, Transaction ID, or Product Reference ID.

  1. Log into the Merchant Portal
  2. On the left navigation bar, click on Leads
  3. Select the parameter you want to search by using the search dropdown (Customer Email by default)
  4. Click the Search button

Applying the Transaction Date Filter

Click on the Lead Transaction Date chip to apply a date range filter on the Leads List View.

View Lead Details

You can use the Merchant Portal to drill into any of your leads and view information about the customer, product, status and more.

  1. Log into the Merchant Portal
  2. On the left navigation bar, click on Leads
  3. Search or filter to find a specific lead
  1. Click on the lead in the list view

Post-Purchase Upsell Email Management

🔐

This feature needs to be enabled by your MSM

The Lead Email Management functionality needs to be enabled by your MSM. Please contact your MSM and see Prerequisites for Extend’s PUE Module. You will not see the Leads Email Management tab in the Merchant Portal until you have the feature enabled.

In addition to viewing and copying Lead information, you can opt into having automated Post-Purchase Upsell emails sent to every eligible customer. The Leads Email Management feature allows you to do the following:

  • Enable / disable automated Post-Purchase Upsell Emails being sent to customers
  • Set / update the email type to be Transactional or Marketing based on your use case. Your selection determines the allowed values for Sending Email Address and Reply-to Email Address.
  • Customize the logo, look and feel of your Post-Purchase Email to be different than your Contract purchase emails
  • Trigger test emails of your Post-Purchase Email campaign to your email address of choice to preview the emails that your customers will receive

Enable / Disable Post-Purchase Upsell Emails

You can use the Merchant Portal to enable or disable automated Post-Purchase Upsell Emails to your eligible customers.

  1. Log into the Merchant Portal
  2. Click on the Leads tab
  3. Click on the Leads Email Management tab
  1. To turn ON automated Post-Purchase Upsell Emails, check the "Send emails to customers" checkbox
  2. Click the Save Changes button on the dropdown banner.

To disable your automated Post-Purchase Upsell Emails:

  1. Log into the Merchant Portal
  2. Click on the Leads tab
  3. Click on the Leads Email Management tab
  4. To turn OFF automated Post-Purchase Upsell Emails, uncheck the "Send emails to customers" checkbox
  5. Click the Save Changes button on the dropdown banner.

Set and Update your Post-Purchase Upsell Email Type

You can use the Merchant Portal to set and update your Post-Purchase Upsell Email type to be one of the following:

  • Transactional - Communications directly relating to a specific transaction, limited to 2 email communications and not subject to US CAN-SPAM regulation.
    • Sending Email Address (email address that Post-Purchase Upsell Emails are sent from) is an email address of your choice from your domain e.g. [email protected]
    • Connect directly with your customers using your email and branding
  • Marketing - Communications not related to a specific transaction, limited to 4 email communications and subject to US CAN-SPAM regulation allowing unsubscription to further messages.
    • Sending Email Address (email address that Post-Purchase Upsell Emails are sent from) is an Extend-owned email alias e.g. [email protected]
    • Extend sends marketing emails to your customers on your behalf from an Extend-owned domain

📘

Note

The "Send emails to customers" checkbox must be checked before you can customize your Lead Email Type.

The default selection for Lead Email Type is Transactional.

  1. Log into the Merchant Portal
  2. Click on the Leads tab
  3. Click on the Leads Email Management tab

To update you Lead Email Type to Marketing:

  1. Log into the Merchant Portal
  2. Click on the Leads tab
  3. Click on the Leads Email Management tab
  4. Under Lead Email Type, select Marketing

📘

Note

For more information about Transaction and Marketing email types and the associated setup, see Transactional Emails and Marketing Emails

Customize and Preview your Email Logo and Colors

You can use the Merchant Portal to update and preview your Post-Purchase Upsell Email logo and colors. Previewing allows you to see what your email would look like to customers before you officially publish the changes.

The following fields on your Post-Purchase Upsell Email can be customized and previewed live:

  • Store Name
  • Store Logo (JPG or PNG only, 10MB max file size)
  • Primary Color (Button Color)
  • Button Text Color
  • Light Background Color
  • Header Font
  • Body Font
  • Merchant Address
  • Pricacy Policy Link
  • Merchant Phone Number

To customize your Lead Emails, simply do the following:

  1. Log into the Merchant Portal
  2. Click on the Leads tab
  3. Click on the Leads Email Management tab
  4. Scroll down to the Customize Lead Emails section
  5. Update text / colors on the left hand side and see the updates in realtime in the Preview on the right hand side
  6. Click Save Changes to change your updates

Trigger Test Emails

You can use the Merchant Portal to trigger test emails of your Post-Purchase Email campaign to be sent to your email address of choice. This allows you to preview the emails that your customers will receive. Triggering test emails will send you the series of emails that your customer will receive, specific to Transactional or Marketing email type.

To trigger test Post-Purchase Emails:

  1. Log into the Merchant Portal
  2. Click on the Leads tab
  3. Click on the Leads Email Management tab
  4. Scroll down to the Send Test Emails section
  5. Input the email address you want the test emails to be seent to
  6. Click the Send Test Email(s) button

Within a minute or two, you should receive Post-Purchase Upsell email(s) based on the Email Type and Email Triggers selected in the Lead Email Configuration section.

Export Leads List to CSV

🚧

Leads Export

Each user can export Leads data once every 24 hours. If a specific user in your Extend account attempts to export Leads more than once in 24 hours, they will not receive a Download Email and will be directed to find the previous email sent in the last 24 hours to download their data.

You can use the Merchant Portal to generate a CSV of all Leads and all attributes of your Leads. The exported CSV can be used to generate post-purchase email campaigns within your own email management system.

  1. Log into the Merchant Portal
  2. On the left navigation bar, click on Leads
  3. Click on Export Leads

You will see a message letting you know that your CSV export is currently being processed and that you will receive an email with a link to download as soon as it is ready. This should only take a few minutes.

  1. Check your email (email is sent to user's email who initiated the export)
  2. Within the email notification, click Log in to download and log in if you are not already logged in
  1. After you've been redirected to the download page in the Merchant Portal, click Download CSV to download your Claims CSV file

You should see the CSV file downloading directly in your browser. Depending on the number of records being downloaded, this download can take some time to complete.

📘

Note

Your download link is valid for 3 days from the time you click Export Leads. After 3 days, your link will expire and you will need to initiate an export again.

The exported CSV can be used to perform external analysis of your contract sales. An example of CSV column fields are defined below.

CSV Column TitleDefinition
Lead TokenUnique token representing a lead that is appended to a URL in order to present the correct offer
EmailCustomer’s email address
QuantityQuantity of product purchased that the lead was created for
Quantity ConsumedTotal number of leads consumed out of total quantity
Transaction IDTransaction ID of the associated order in your system
StatusCurrent status of the lead
List PricePrice the product is listed at (in base units)
Purchase PricePrice customer paid for the product (in base units)
Currency CodeCurrency used to purchase the product
TitleName of the product that lead was created for
Reference IDProduct’s ID in your system (often same as SKU ID)
Created DateDate that the lead was created
Expiration DateDate that the post-purchase offer expires and is no longer purchasable

Import Leads CSV to Excel

If you want to import your Leads CSV file into an Excel file, we recommend taking the following steps to ensure your data is not manipulated during the import process:

  1. Open Excel or Google Sheets
  2. Click on File -> Import
  1. Click the Upload tab
  2. Drag in your Leads CSV file or click the Select a file from your device button and select the Leads CSV file
  1. Uncheck the checkbox beside "Convert text to numbers, dates, and formulas"
  2. Click the Import Data button

Copy Lead Token

You can use the Merchant Portal to manually copy a lead token for any lead that your integration has generated. The lead token can be used to manually create a lead URL that can be sent to customers for one-off post-purchase offers.

Copy Lead Token from List View

  1. Log into the Merchant Portal
  2. On the left navigation bar, click on Leads
  3. Search or filter to find a specific lead
  4. From the list view, click the three dots and select Copy Lead Token

Copy Lead Token from Lead Detail View

  1. Log into the Merchant Portal
  2. On the left navigation bar, click on Leads
  3. Search or filter to find a specific lead
  4. Click on the lead in the list view
  5. From the lead detail view, click the Copy Lead Token button

When the lead URL has been successfully copied, you will see a message letting you know that the lead URL was successfully copied to your clipboard.

Copy Lead URL

🔐

This feature needs to be enabled by your MSM

The Copy Lead URL functionality needs to be enabled by your MSM. Please contact your MSM and provide your default Base URL. This is typically the URL of your store where customers can convert (purchase) an Extend Lead. You will not see the Copy lead url button in the Merchant Portal until the Base URL is configured and the feature is enabled.

To avoid the step of manually constructing a Lead URL for your post-purchase email using a base URL and Lead Token, you can use the Copy Lead URL functionality to get a pre-constructed link that can be sent directly to your customer.

A Lead URL is the combination of your specified Base URL and your Lead Token:

Lead URL Structure: {Base URL}?leadToken={Lead Token}

Example: https://merchantwebstore.com?leadToken=febdc18a0409ee883e5f64a7842d74dc

Update your Base URL

  1. Log into the Merchant Portal
  2. On the left navigation bar, click on Settings
  3. Navigate to the Lead URL Configuration section
  4. Enter a new Base URL and click the Save button

📘

Note

The URL that is saved in the Lead URL Configuration section is the URL that your customer will be directed to when they click the link. This URL can be updated any time.

Copy Lead URL from List View

  1. Log into the Merchant Portal
  2. On the left navigation bar, click on Leads
  3. From the list view, click the three dots and select Copy Lead URL

When the lead URL has been successfully copied, you will see a message letting you know that the lead URL was successfully copied to your clipboard.

Copy Lead URL from Lead Detail View

  1. Log into the Merchant Portal
  2. On the left navigation bar, click on Leads
  3. Search or filter to find a specific lead
  4. Click on the lead in the list view
  5. From the lead detail view, click the Copy Lead URL button

When the lead URL has been successfully copied, you will see a message letting you know that the lead URL was successfully copied to your clipboard.

Create a single Lead Manually

Leads records are automatically created for merchants who are integrated with Extend's Orders API, or have previously integrated with Extend's Leads API. Users can also create a lead record manually when one is missing or expired, or to facilitate a warranty purchase for whatever reason after the initial sale of the product. To create a lead manually, follow the steps below.

  1. Log into the Merchant Portal
  2. On the left navigation bar, click on Leads
  3. Click the Create Lead button.
  4. Click on the lead in the list view
  1. Fill out the Lead information, using the field tool tips for guidance.
    1. The Extend Product Reference ID entered must match with a warrantable product in your Merchant Portal catalog that has a mapped warranty plan.
  1. Click Save
  2. Successful toast message will appear and you can navigate to the new Record in the Lead List, or by clicking the View Details link in the toast.

Field and Status Definitions

Every lead has a specific set of fields describing the details and status of the lead. The following fields are defined below. Additionally, you can view the field/status definitions within the Merchant Portal by hovering your cursor over column titles in your leads list view or clicking the information icon beside the Status field.

Leads List View Field Definitions

Field NameField Definition
Transaction IDTransaction ID in your system (typically order ID)
DateOrder creation date
Customer NameCustomer’s name
Customer EmailCustomer’s email address
Product Ref IDProduct’s ID in your system (often same as SKU)
Product NameProduct name displayed to customers
Purch PricePrice customer paid for product after any discounts applied
StatusCurrent status of the lead

Lead Details View Field Definitions

Field NameField Definition
Product NameProduct name displayed to customers
StatusCurrent status of the lead
Transaction IdTransaction ID associated with the initial order in your system (typically order ID)
Customer EmailCustomer’s email address
Product Ref IdProduct’s ID in your system (often same as SKU)
Product Purchase PricePrice customer paid for product after any discounts applied
Lead TokenUnique ID of the lead in Extend's system
QuantityTotal number of leads available for post-purchase product protection sales. If the customer purchased two of the same product and did not purchase a warranty for either product, quantity would be '2'
Quantity ConsumedTotal number of leads that have converted to contract sales

Status Definitions

Status NameStatus Definition
LiveThe customer is eligible for a post-purchase Product Protection Offer
ConsumedThe customer has already purchased the post-purchase Product Protection Offer
ExpiredThe customer eligibility for a post-purchase Product Protection Offer has expired