Introduction

This API is designed to allow updating of a single "Mail queue" record (any survey record not sent out yet) in CustomerGauge.


Good to know

API response format:

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


About this API

Resource Information

Response formats
JSON (default), XML
HTTP method
PUT
Response family
Transactions
Header
Authorization: api_key XXXXX


Resource URL

Europe Production Server: https://api.customergauge.com/v4.1/transactions/mailqueue.json

US Production Server: https://api.us.customergauge.com/v4.1/transactions/mailqueue.json

Australia Production Server: https://api.au.customergauge.com/v4.1/transactions/mailqueue.json


How to call

PUT Data

Put data as key value based on upload mapping.


Parameters

Key
Data
id (Required)
CG-ID
Example Value: 63
CustomerNumber
1143
Email
lee_klameth@directness.net
FirstName
Lee
LastName
Klameth


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 Import Data (usually under the Admin or Setup menu)

2. Click on "Upload File"


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


4. Use the column names (if you downloaded CSV or XLS), or the XML tag labels.


Example Request

To call this API through cURL:

curl -H "Authorization: api_key XXXXX" -X PUT https://api.eu.customergauge.com/v4.1/transactions/mailqueue.json? -d id=63 -d CustomerNumber=1143 -d Email=lee_klameth@directness.net -d FirstName=Lee -d LastName=Klameth


Example Result

Message reported on successful operation:

{
  "Data": {
    "id": 63
  }
}


Message reported on failed operation:

{
  "Error": {
    "Message": "Field CGNumber is required but seems to be empty",
    "Code": 400010
  }
}


Not the API you're looking for?

Related APIs:


APIs of the same family:


Similar API families:


Or view: