This function is designed to allow upload of a contact list directly into CustomerGauge’s Address Book. Emails will not be sent out automatically. It will need to be sent manually using the Email Engine from inside of the CustomerGauge application.
IMPORTANT: The File Size Limit for API's is 2MB.
Resource Information
|
Response formats |
JSON (default), XML |
|
HTTP Method |
POST |
|
Response family |
file |
|
Header |
Authorization: api_key XXXXX |
Resource URL
Production Server: https://api.customergauge.com/v4.1/file/contact.json
Uploading Files
Files can be uploaded by posting the file itself.
Upload by File Posting
Upload File Data
Post data as if posted by a form.
Upload File Data Example
|
Key |
Data |
Description |
| file |
Documents/file_name.xml |
Automatically provided when POST-ing a file through HTTP protocol. |
Upload File Example Request
| cURL Example |
curl -F “file=@LOCAL_LOCATION/file_name.xml” “https://api.customergauge.com/v4.1/file/contact.json” |
Example Result
Data states if successful or not. Message reported on successful operation:
|
1 |
{"Data":{"id":"3"}} |
Message reported on failed operation:
|
1 |
{"Error":{"Message":"This upload has already been processed","Code":400103}} |