File - POST Contact
Modified on: Fri, 25 Jan, 2019 at 11:25 AM
Introduction
This API is designed to allow upload of a single data file directly into CustomerGauge's Contact List. Emails will not be sent out automatically, but will need to be sent manually using the Delivery Manager from inside of the CustomerGauge application.
Good to know
Maximum file size:
Please do not upload files larger than 2MB.
Maximum number of records:
Please do not upload files with more than 2,000 records.
Upload interval / frequency:
Multiple upload calls made in quick succession will get queued, and periodically retried, but to obtain optimum performance we recommend allowing the previous upload to finish before attempting the next one. (Uploads can take anywhere between a few seconds and several minutes depending on the size and complexity of data.)
Uploadable file types:
We accept CSV, XLS(X), and XML files (note: no JSON files).
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 | POST |
| Response family | File |
| Header | Authorization: api_key XXXXX |
Resource URL
Europe Production Server: https://api.eu.customergauge.com/v4.1/file/contact.json
US Production Server: https://api.us.customergauge.com/v4.1/file/contact.json
Australia Production Server: https://api.au.customergauge.com/v4.1/file/contact.json
How to call
Parameters
| Key | Data | Description |
| file | Documents/file_name.xml | Automatically provided when POST-ing a file through HTTP protocol. |
Sample file
As many clients have different data fields, you can pick up a sample copy from your system.
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 Contact List (CSV), Contact List (XLS), or Contact List (XML).
Note: if Contact List is not being displayed, please contact your Customer Success Manager.
4. Use the same structure as this sample file when calling our POST File/Contact API.
Upload File Example Request
Post your file by calling our API as if posted from a form.
curl -H "Authorization: api_key XXXXX" -F "file=@LOCAL_LOCATION/file_name.xml" "https://api.eu.customergauge.com/v4.1/file/contact.json"
Example Result
Data states if successful or not. Message reported on successful operation:
{
"Data": {
"id": "3"
}
}Message reported on failed operation:
{
"Error": {
"Message": "This upload has already been processed",
"Code": 400103
}
}Not the API you're looking for?
Related APIs:
APIs of the same family:
Similar API families:
Or view:
Did you find it helpful? Yes No
Send feedback