Please note: This is an older API. We highly recommend to use the PUT Records API instead.


This API is designed to allow upload of a single data file directly into CustomerGauge for immediate processing (Mail queue) and email sending.

Depending on active rules and data types (usually order_date field) customer emails will be sent immediately.

This API will load emails into the "Mail queue", and may start immediate processing. Make sure you test this before bulk uploads!

Good to know

API response format:

Our APIs return data in either JSON or XML format (depending on request by .json or .xml).

Required fields & field validations:

Based on your system's configuration, some fields may be required, or need to be in a specific format.

Contact your Customer Success Manager when in doubt.

Usually, the following validations apply:

  • Datetime is required and in YYYY-mm-dd H:i:s format.
  • Email is required for the upload to be valid

About this API

Resource Information

Response formats
JSON (default), XML
HTTP Method
Response family
Authorization: api_key XXXXX

Resource URL

Europe Production Server:

US Production Server:

Australia Production Server:

How to call


Post data as key value based on upload mapping.

POST Data Example Values


Sample file

As many clients have different data fields, you can pick up a sample copy from your system – this will contain the field names to be used as Key (as displayed above).

1. Go to Data → Imports in the menu, and click the link to the legacy import screen. 

2. Click on "Upload File"

3. Click on "Download Data Structure", followed by Transactional (XML).

4. Use the xml tag labels as key names.

Example Request

Oauth2 Example

1. Authenticate to obtain your Access Token.

2. Execute the following cURL command, replacing XXXXX with your Access Token:

curl -H "Authorization: Bearer XXXXX" -X POST -d CustomerNumber=1143 -d -d FirstName=Lee -d LastName=Klameth

API Key Example

1. Execute the following cURL command, replacing XXXXX with your API Key:

curl -H "Authorization: api_key XXXXX" -X POST -d CustomerNumber=1143 -d -d FirstName=Lee -d LastName=Klameth

Example Result

Message reported on successful operation:

  "Data": true

Message reported on failed operation:

  "Error": {
    "Message": "Field email is required but seems to be empty.",
    "Code": 40003

Not the API you're looking for?

Related APIs:

APIs of the same family:

Similar API families:

Or view: