Recent Customer Purchase Upload

Overview

Extole referral and engagement programs are efficient avenues for acquiring new customers. To ensure you are incentivizing—and rewarding—new customer activity, you can send recent customer activities to Extole. Doing so ensures that existing customers' referred signups, purchases, account openings, or bookings do not reward an advocate.

📘
Note
Once you have launched your program using conversion tags or the conversion API, Extole will automatically store recent purchase information. Uploading recent purchases is only needs to be done once during launch if you wish to exclude historical customers.

Acquisition campaigns normally include both brand new customers and win-back customers who haven't engaged with your brand in the prior 12 months. You do not need to load your entire customer history, but only the previous 12 months and only the most recent actions performed by those customers.

You can either use the Extole API to send in events or you can upload an event file to My Extole or via SFTP.

API Call

Generate API Keys

Make sure you have generated API keys through the My Extole Security Center.

After creating an API Key in My Extole, you can use the Create Event API call to send in the list of recent registrations, account openings, subscriptions, purchases, etc. via API call. Each account opening or purchase event uses a single call to Extole:

POST https://api.extole.io/v5/events

{
  "event_name":"conversion",
  "data":{
    "required_labels":"existing_customer",
    "email":"[email protected]",
    "first_name":"julio",
    "last_name":"friend",
    "partner_user_id":"ABcd234A1s",
    "partner_conversion_id":"12294838abs2",
    "event_time":"yyyy-MM-dd'T'HH:mm:ssZ",
    "cart_value":"100"
  }
}

Input Parameters

Input Parameter	Description
`data.partner_conversion_id` required	The unique identifier of the event, this might be something like an order number. This is required to ensure there are no duplicate events sent to Extole and for report reconciliation. Maximum of 38 characters.
`data.partner_user_id` sometimes required	Your unique identifier of the customer. This is not required, but is recommended so that if this identifier is passed in again during a future purchase, this person can be recognized as an existing customer. Either the `partner_user_id` OR the email is required_.
`data.email` sometimes required	The email address of the customer. This is not required, but is recommended so that if this email is passed in again in the future, this person can be recognized as an existing customer. Either the `partner_user_id` OR the email is required_.
`data.first_name`	The first name of the customer.
`data.last_name`	The last name of the customer.
`data.cart_value` recommended	The revenue value of the transaction (if applicable) used for reporting.
`data.event_time`	The date when the event was created

File Upload

You can also upload an existing customer file to your SFTP account at My Extole or through your Account inside of My Extole.

Event File Records

Column Name	Required	Validation	Description
`event_name`	Yes	`eventname`	The type of event to create from the list (e.g., conversion, sign_up, account_opening).
`required_labels`	Yes	`existing_customer`	The required labels field ensures that the events are properly mapped as existing customer upload (not a new referral conversion).
`email`	Maybe	256 characters	The email address of the customer. This is not required, but is recommended so that if this email is passed in again in the future, this person can be recognized as an existing customer. Either the partneruser_id OR the email is required.
`partner_user_id`	No	38 characters	Your unique identifier of the customer. This is not required, but is recommended so that if this identifier is passed in again during a future purchase, this person can be recognized as an existing customer. Either the `partner_user_id` OR the email is required_.
`first_name`	No	38 characters	The first name of the customer.
`last_name`	No	38 characters	The last name of the customer.
`event_time`	No	ISO_8601 DateTime	The date and time of the event as ISO_8601 format. Generally this is YYYY-MM-DDThh:mm:ssZ (e.g. "2013-08-11T14:33:18-0700"). If not provided, Extole will use the processing time of the event file as the event time.
`partner_conversion_id`	No	38 characters	The unique identifier of the event, this could be something like an order number. This is required to ensure there are no duplicate events sent to Extole and for report reconciliation.
`cart_value`	No	Number with two decimal places	The revenue value of the transaction (if applicable) used for reporting.

Filename: /events/2147483647_conversion_20130619000000.csv

event_name,required_labels,email,event_time,partner_conversion_id,cart_value
conversion,existing_customer,[email protected],2013-06-19T10:12:53-0700,00540000001PULM,20.34
conversion,existing_customer,[email protected],2013-06-19T11:42:51-0700,00540000001O1fi,100.28
conversion,existing_customer,[email protected],2013-06-19T12:16:12-0700,0064000000QP7SN,99.99