CustomerGauge API uses conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g. a required parameter was missing, a charge failed, etc.), and codes in the 5xx range indicate an error with CustomerGauge servers.


HTTP Status Code Summary

  • 200 OK – Everything worked as expected.
  • 400 Bad Request – Often missing a required parameter.
  • 401 Unauthorized – No valid API key provided.
  • 500, 502, 503, 504 Server errors – something went wrong on CustomerGauge end.

Example of Error Message

JSON



1

{"Error":{"Message":"Invalid API Key","Code":2000}}
XML


1

<Error><Message>Invalid API Key</Message><Code>2000</Code></Error>

Error Codes 

Code Category Subcategory Reason HTTP Status
200000 API Authentication
Invalid API key 401
300000 General
Too many params supplied 400
300001 General
Invalid arguments supplied 400
300002 General
Module does not exist
 404
300003 General
Method does not exist
 405
300004 General
Required field does not supplied 400
400000 Modules Transactions Filter key doesn’t exist 400
400001 Modules Transactions Date method doesn’t support 400
400002 Modules Transactions Record does not exist 400
400003 Modules Transactions Failed to insert record 400
400004  Modules Transactions Wrong id provided 400
400005  Modules Transactions id not found 400
400006 Modules Transactions No mapping found for date form completed
 400
400007 Modules Transactions Date form completed value should be supplied for response upload 400 
400008 Modules Transactions  Date form completed value should not be supplied for non response upload
 400 
400009 Modules Transactions Days can’t be more than 365
 400
400010 Modules Transactions Field id is required but seems to be empty
 400
400011 Modules Transactions Workflow status does not exist 400
400100 Modules File Could not find requested file. 400
400101 Modules File S3 location can not be empty. 400
400102 Modules File Could not load field configurations. 400
400103 Modules File Upload has already been processed. 400
400104 Modules File File type could not be determined. 400
400105 Modules File File could not be found. 400
400106 Modules File File is not of valid file type. 400
400107 Modules File Could not parse XML correctly. 400
400108 Modules File Duplication Rule is not of an expected format. 400
400109 Modules File Could not retrieve Duplication Rule. 400
400110 Modules File Could not find posted temp file. 400
400111 Modules File File name of posted file is not valid. 400
400112 Modules File Could not find requested file. 400
400113 Modules File File name of requested file is not valid. 400
400115 Modules File File data can not be empty. 400
400116 Modules File Failed loading XML. 400
400120 Modules File Could not make connection to database. 400
400121 Modules File Duplication Rule is not of an expected format. 400
400122 Modules File Query could not be executed correctly. 400
400123 Modules File Something went wrong while detecting duplication. 400
400124 Modules File Could not parse duplication rule correctly. 400
400140 Modules File Method of uploading unclear; should be POST params s3 or http or upload by POST. 400
400141 Modules File Failed to retrieve list of Transactional uploads 400
400142 Modules File ID required, but missing 400
400143 Modules File ID can not be empty 400
400160 Modules File Method of uploading unclear; should be POST params s3 or http or upload by POST. 400
400161 Modules File Failed to retrieve list of Contact uploads 400
400162 Modules File ID required, but missing 400
400180 Modules File Method of uploading unclear; should be POST params s3 or http or upload by POST. 400
400181 Modules File Failed to retrieve list of Historical uploads 400
400182 Modules File ID required, but missing 400
400183 Modules File ID can not be empty 400
400184 Modules File No data found with passed parameters 400
400201 Modules Workflow Required field ‘number_customergauge’ not supplied 400
400300 Modules Products Couldn’t get data from given url
 400
400301 Modules Products No data provided
 400
400302 Modules Products Field doesn’t exist
 400
400303 Modules Products No mapping field found for product API output
 400
400400
 Modules Lists No mapping field found for unsubscribe API output
 400
400402
 Modules Lists Email address is required 400
400403 Modules Lists Email address already exist in the unsubscribe list 400 
400404 Modules Lists No mapping field found for bounce API output 400 
400500 Modules Company Summary No mapping field found for company_summary API output
 400 
400501 Modules Company Summary Date method doesn’t support
 400
400601 Modules Reasons  Required field ‘reason_code’ not supplied
 400 
400602 Modules  Reasons  Reason code already exist
 400 
400603 Modules Reasons  Reason code does not exist
 400 
400604 Modules  Reasons  Record not inserted. Something went wrong. Please check your data.
 400 
400605 Modules Reasons  Record not updated. Something went wrong. Please check your data.
 400 
400606 Modules Reasons Level 2 can’t save without having Level 1
 400
400607 Modules Reasons Required field ‘good_bad’ not supplied
 400
400608 Modules Reasons Wrong data provided on ‘good_bad’ field
 400
400700 Modules Stream No data provided
 400
400800 Modules Anonymize Required field ‘id’ not supplied
 400
400900 Modules Hierarchy Parent doesn’t exist
 400
400901 Modules Hierarchy Division doesn’t exist
 400
400902 Modules Hierarchy Global division can not be updated
 400
400903 Modules Hierarchy Global division can not be deleted
 400
400904 Modules Hierarchy Parent division can not be deleted
 400