Introduction

This API is designed to delete entire records coming from an uploaded file.


You can use this API to delete the File, and all generated records for Transactional, Historical, and/or Revenue uploads.


Note that when deleting Transactional files, this includes ‘Completed’ records where a survey recipient has already submitted a response to the survey.


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
DELETE
Response family
File
Header
Authorization: api_key XXXXX


Resource URL

Europe Production Server: https://api.eu.customergauge.com/v4.1/file.json

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

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



How to call

Parameters

id 
File upload ID
Example Values: 12


Example Requests

curl -H "Authorization: api_key XXXXX" -X DELETE "https://api.eu.customergauge.com/v4.1/file.json?id=12"



Example Result

Message reported on successful operation:

{
  "Data": true
}


Message reported on failed operation:

{
  "Error": {
    "Message": "File not found",
    "Code": 400200
  }
}


Not the API you're looking for?

Related API families:


Or view: