POST Anonymize Contact

Modified on: Fri, 25 Jan, 2019 at 11:37 AM


Introduction

This API is designed to allow you to Anonymize Customer data including Segment fields that is agreed to during system setup process. 


IMPORTANT: We recommend you read the "Good to Know" and "About this API" information below carefully before using the API.


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

The API Feature:

  • You can call the API using the Email Address or SMS Number of the contact you wish to anonymize.
    • If you call the API using Email: It will find all the past customer records associated with that email address and anonymize all the information for those records.
    • If you call the API using SMS: It will find all the past customer records associated with that SMS and anonymize all the information for those records.


  • When you call the API there is a Default list of fields that will be anonymized. Below outlines the default list of fields and what will happen to the information.
    • Email - will be converted to a random generated email address
    • First Name -  will be changed as ***
    • Last name - will be changed as ***
    • SMS/Telephone Number - will be changed as***
    • Customer Number - will be changed to ***
    • Job Level - will be changed to *
    • Job Position - will be changed to --
    • Follow-up Details - will be changed to ***
    • NPS Comment - will be shown as "This comment has been anonymised based on customer request"
    • Comment Translation - will be shown as "This comment has been anonymised based on customer request"
    • Workflow Comment - will be shown as "This comment has been anonymised based on customer request"
    • Auto reply - will be shown as "This comment has been anonymised based on customer request" and the email link will no longer be available
    • Review Comment  - will be shown as "This comment has been anonymised based on customer request"  on the reviews widget and website, also all comments made by an user on the reviews widget will be anonymised
    • Additional Comment - will be shown as "This comment has been anonymised based on customer request"


  • In addition to the above - you can request to add more segment values (to be anonymized) to the list for your organization. In order to add segment fields list to the defalut list to be anonymized for your company, please contact your Customer Success Manager.

Please note: if you choose to anonymize company as an additional field, the new monetize widgets will not work precisely because the link between the person and the company will be lost.


  • The API will remove personal information permanently. Please make sure you provide correct key of the person you wish to anonymize! There is no revert option.


Resource Information

Response formats
JSON (default), XML
HTTP method
POST
Response family
Anonymize
Header
Authorization: api_key XXXXX


Resource URL

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

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

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


How to call

POST Data

Post email address OR telephone as key value.


Parameters

You can choose either of the parameters below (but not both):

Key
Data
email
john.doe@example.com
telephone
123456789


Example Requests

GET (json)
https://api.eu.customergauge.com/v4.1/anonymize.json?api_key=XXX&email=john.doe@example.com


CURL call

curl -H "Authorization: api_key XXXXX" -X POST https://api.eu.customergauge.com/v4.1/anonymize.json -d email=john.doe@example.com



Example Result

Message reported on successful operation:

{
    "Data": {
        "message": "Record updated successfully"
    }
}


Message reported on failed operation:

{
    "Error": {
        "Message": "Please make an API request by email or telephone"
    }
}


{
    "Error": {
        "Message": "Email is not valid"
    }
}


Not the API you're looking for?

Related APIs:


Or view:



Did you find it helpful? Yes No

Send feedback
Sorry we couldn't be helpful. Help us improve this article with your feedback.