Introduction

This API allows you to delete a record that resides in "Mail queue" by CG-ID.


Good to know

Caution!

Be careful using this. It will PERMANENTLY delete records from the main database and they CANNOT be restored.


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
Transactions
Header
Authorization: api_key XXXXX


Resource URL

Europe Production Server: https://api.eu.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

Parameters

id
required
CG-ID
Example Values: 12


Example Request

To call this API through cURL:

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


Example Result

Message reported on successful operation:

{
  "Data": {
    "id": 12
  }
}


Message reported on failed operation:

{
  "Error": {
    "Message": "Record does not exist",
    "Code": 400002
  }
}


Not the API you're looking for?

Related APIs:


APIs of the same family:


Similar API families:


Or view: