Introduction

This API is designed to verify the information before Anonymization.

Once you've verified that these are the records you'd like to anonymize, you can use the POST Anonymize API to proceed.


About this API

Resource Information

Response formats
JSON (default), XML
HTTP method
GET
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

GET Data

Use email address or telephone as key value.


GET Data Parameters Example Values

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 GET https://api.eu.customergauge.com/v4.1/anonymize.json -d email=john.doe@example.com


Example Result

Message reported on successful operation:

{
    "Data": [
        {
            "first_name": "John",
            "last_name": "Doe",
            "email": "john.doe@example.com",
            "sms_telephone": "123456789",
            "number_customergauge": "10438"
        }
    ],
    "total": 1
}


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: