API DOCUMENTATION Last Update: Apr 2022

Delete a Customer

Deletes a customer from the account PERMANENTLY.

 

The data to be submitted to the API is composed of the following fields:

 

  field   Example   Note
user_id john1970 Required
user_password 1959caadac9b13dcb3 Required
type customer_delete Required
account_id greatwidgets Required
code 1234567890123456 Required
Output Format:
output JSON or XML Optional. If not provided, defaults to XML
callback someFunctionName Optional: JSONP format
condensed yes Optional (No white space)
Applies only to JSON(P) output

 

WARNING: THIS IS A PERMANENT DELETE. THERE IS NO UNDO!
This call deletes ALL information related to that customer:

  • Removes ALL customer data such as name, card number, etc.
  • Removes ALL customer transactions in ALL account campaigns.
  • Remoces ONLY one customer at a time to avoid accidentally wiping the whole database.

Notes:

If you want to remove more than one customer at a time, implement a loop in your code that makes this call for each customer that you want removed. This way, if the whole customer database gets erased accidentally, the fault lies with your code, not ours. :)

Example PHP Request:

If you are using PHP, the $data array would look like this:

  1. $data['user_id'] = 'john1970';
  2. $data['user_password'] = '1959caadac9b13dcb3';
  3. $data['type'] = 'customer_delete';
  4. $data['account_id'] = 'greatwidgets';
  5. $data['code'] = '1234567890123456';

 

Success XML Response:

  1. <response status="success">
  2. <customer status="deleted">
  3. <code>1234567890123456</code>
  4. </customer>
  5. </response>

 

Error XML Response:

  1. <response status="error">
  2. <error>Error message</error>
  3. </response>