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 default list to be anonymized for your company, please contact our Support Team or your Account or Implementation Manager.
  • Custom fields cannot be anonymized, please keep that in mind when defining your data structure.

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: Bearer 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


Authentication

OAuth2 Authentication is used to connect to this API. In order to create the Connected App, which is needed to generate the Access Token, Administrator access to CustomerGauge is needed. Once you've created your Connected App, you can acquire a Bearer Access Token by calling our OAuth2/Token API:

curl -X POST -H "Content-Type: application/x-www-form-urlencoded"
-d "grant_type=client_credentials&client_id={{ Client ID }}&client_secret={{ Client Secret }}"
https://auth.{{ apiRegion }}.customergauge.com/oauth2/token

The acquired Bearer Access Token is used in the Authorization header in your API request.


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?email=john.doe@example.com


CURL call

curl -H "Authorization: Bearer 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: