Documentation Index
Fetch the complete documentation index at: https://docs.mention-me.com/llms.txt
Use this file to discover all available pages before exploring further.
Overview
This page describes the different types of data that can be sent to Mention Me via SFTP. All data must be in structured CSV format.For connection details and folder structure, see SFTP Connection.
Data Types
Mention Me accepts several types of inbound data via SFTP. Thetype column on each row selects which feed the row belongs to.
Order / Transaction Data (type: order)
Order / Transaction Data (type: order)
Used to send order or transaction data for conversion tracking. Each row represents a single order.Required fields:
Recommended fields:
| Field | Description | Example |
|---|---|---|
type | Must be order | order |
CustomerEmail | Customer’s email address | customer@example.com |
OrderId | Unique order identifier | ORD-12345 |
OrderDate | Date of order (ISO 8601) | 2024-01-15T10:30:00Z |
OrderTotal | Order total excluding VAT/taxes and delivery | 49.99 |
OrderCurrency | ISO 4217 currency code | GBP |
| Field | Description |
|---|---|
CustomerFirstname | Customer’s first name |
CustomerSurname | Customer’s last name |
MerchantCouponCode | Voucher code used (if any) |
CustomerId | Your internal customer identifier |
OrderItemCount | Number of items |
OrderDiscountAmount | Discount applied |
OrderIsSubscription | Whether this is a subscription order (true/false) |
OrderIsGift | Whether this order is a gift — gifts can be signals of advocacy |
Locale | Locale code (e.g. en_GB) |
Segment | Customer segment |
Customer Registrations (type: register / register-silently)
Customer Registrations (type: register / register-silently)
Used to register customers into the referral programme. The
Optional fields:
type value determines whether a confirmation email is sent: use register to send a welcome email, or register-silently to register the customer without contacting them.Required fields:| Field | Description | Example |
|---|---|---|
type | register or register-silently | register |
CustomerEmail | Customer’s email address | customer@example.com |
CustomerFirstname | Customer’s first name | Jane |
CustomerSurname | Customer’s last name | Smith |
| Field | Description |
|---|---|
OrderId | Associated order |
OrderDate | Order date |
OrderTotal | Order total |
OrderCurrency | Currency |
MerchantCouponCode | Voucher used |
CustomerId | Your customer ID |
Locale | Locale code |
Segment | Customer segment |
Cancelled Referees (type: referee-cancelled)
Cancelled Referees (type: referee-cancelled)
Used to notify Mention Me that a referee’s qualifying order has been cancelled, so any pending referrer reward can be withdrawn.Required fields:
| Field | Description | Example |
|---|---|---|
type | Must be referee-cancelled | referee-cancelled |
CustomerEmail | Customer’s email | customer@example.com |
OrderId | The cancelled order ID | ORD-12345 |
Eligible Referees (type: referee-eligible)
Eligible Referees (type: referee-eligible)
Used to confirm after a holding/return period that a referee’s order has become eligible, so the referrer can be rewarded.Required fields:
| Field | Description | Example |
|---|---|---|
type | Must be referee-eligible | referee-eligible |
CustomerEmail | Customer’s email | customer@example.com |
OrderId | The order that has become eligible | ORD-12345 |
Coupon Redemption (type: coupon-redemption)
Coupon Redemption (type: coupon-redemption)
Used for in-store coupon redemption tracking.Required fields:
| Field | Description | Example |
|---|---|---|
type | Must be coupon-redemption | coupon-redemption |
MerchantCouponCode | The redeemed coupon code | REF-ABC123 |
OrderId | Associated transaction | TXN-789 |
OrderDate | Transaction date | 2024-01-15 |
OrderTotal | Transaction value | 75.00 |
OrderCurrency | Currency | GBP |
Customer Details Changed (type: customer-details-changed)
Customer Details Changed (type: customer-details-changed)
Used to notify Mention Me of customer account changes, most commonly an email address update, so the customer’s referral history is preserved against their new details.Required fields:
| Field | Description | Example |
|---|---|---|
type | Must be customer-details-changed | customer-details-changed |
CustomerEmail | Customer’s current email | old@example.com |
NewCustomerEmail | Customer’s new email | new@example.com |
Lapsed Customers (type: customer-lapsed)
Lapsed Customers (type: customer-lapsed)
Used to inform Mention Me that a customer is considered lapsed in your system. Lapsed customers can be targeted with win-back messaging or excluded from certain referral flows.Required fields:
| Field | Description | Example |
|---|---|---|
type | Must be customer-lapsed | customer-lapsed |
CustomerEmail | Customer’s email | customer@example.com |
Incentivised Actions (type: incentivised-action)
Incentivised Actions (type: incentivised-action)
Used to record non-order actions (for example, account sign-up, booking, milestone event) that should trigger a reward or progress in your referral programme.Required fields:
| Field | Description | Example |
|---|---|---|
type | Must be incentivised-action | incentivised-action |
CustomerEmail | Customer’s email | customer@example.com |
OrderId | A unique identifier for the action | ACT-12345 |
OrderDate | When the action took place | 2024-01-15T10:30:00Z |
Purge (type: purge)
Purge (type: purge)
Used to request deletion of a customer’s data held by Mention Me, for example to satisfy a data-subject erasure request.Required fields:
| Field | Description | Example |
|---|---|---|
type | Must be purge | purge |
CustomerEmail | Email address of the customer whose data should be purged | customer@example.com |
File Format Requirements
- Format: CSV with headers
- Encoding: UTF-8
- Delimiter: Comma (
,) - Line endings: Unix (
\n) or Windows (\r\n) - Quoting: Fields containing commas, quotes, or newlines must be double-quoted
- Column names: PascalCase, case sensitive — mis-named columns are silently ignored on import
- Mixed feeds: A single file may contain rows with different
typevalues; each row is processed according to itstype