This guide is aimed to help you walk through the steps to Anonymize a Customer Record in CustomerGauge via API. 


What does Anonymization mean?


When you anonymize a Customer Record in CustomerGauge - the personal data (example first name, last name etc.) and segment values identified by you will be anonymized (replaced either with *** or completely blanked out). Once Anonymized the information cannot be retrieved again. 




What details will be Anonymized?


When you anonymize a record in CustomerGauge, please see below on what will happen to the information.


The Default List of fields:


Field List
Result after Anonymization
Email
will be converted to a random generated email address
First Name
***
Last name
***
SMS/Telephone Number
***
Follow-up Details
***
Customer Number***
Job Level        *
Job Position--
NPS Comment
"This comment has been anonymised based on customer request"
Comment Translation
"This comment has been anonymised based on customer request"
Workflow Comment
"This comment has been anonymised based on customer request"
Direct Reply/Auto Reply
"This comment has been anonymised based on customer request" and the email link will no longer be available
Review Comment  
"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 
"This comment has been anonymised based on customer request"




What happens to the Segment Value Information?


IMPORTANT: Please align with your Customer Success Manager (CSM) on the list of Segment Fields that you would like to have anonymized by default for all records. This is in addition to default list of fields mentioned above. This is a one time activity and will apply for all customers records that are anonymized using the Anonymize API after the setup. If you do not specify this with your CSM then these segment values will not be anonymized!


  • The Segment reference will be removed for that particular Customer record. It will appear that this record did not have a segment reference at all.
  • IMPORTANT: 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.




What will happen to my Survey Results?


Some of Survey Result information of the record that you anonymized will remain accessible. 


Information that will not be anonymized are


Email Sent Date

Survey Completed Date

NPS Score

Drivers (Self-Select Reasons)
Follow-up Requested - Yes or No
Additional Rating Question
Drop Down, Radio Button, Check Box Questions
CSAT Question
CES Question



Information that will be anonymized are


Comment
Additional Comment
Review Comment
Follow-up Details
Input Boxes




What do I need to get started?


1. Alignment with your Customer Success Manager (CSM) on the list of Segment Fields that you would like to have anonymized by default for all records. By default there is a standard list of fields that we will anonymize but in addition to this you might want to anonymize certain segment field vales that might contain personal information. This is a one time activity and will apply for all customers records that are anonymized using the Anonymize API after the setup. If you do not specify this with your CSM then these segment values will not be anonymized!


2. Technical knowledge on how to call CustomerGauge APIs


3. One of the unique identifiers for the person requesting to be removed from your data; their e-mail address or SMS telephone number.


4. Any other API interface tool that allows GET and POST API calls


5. Your CustomerGauge API key (Available in your CustomerGauge System)


6.  GET Anonymize API (To verify the information before Anonymization) and POST Anonymize API (to anonymise the customer record/records) documentation





The How to Guide:


Step 1: Verify the details of the customer before you anonymize the information. Do note that a Customer can have multiple CustomerGauge records under the same Email address or SMS number. 


a. Call the GET Anonymize API 

    a. Fill in the parameter email or telephone depending on the unique identifier you've picked (see requirement 2)

    b.Make sure to provide the api_key parameter in the Headers section, using "Authorization" as the key


Step 2: Check the result(s) of the GET Anonymize API and confirm that these are the records you'd expect


Step 3: If the results meet your expectations, call the POST Anonymize API with the unique identifier you just used on the GET API


Step 4: The details of this person should be anonymized in the platform.