Many of our 4.1 APIs have been retired or sunset and replaced with API v7 equivalents. Please use our latest APIs from v7 in any such case. 

TABLE OF CONTENTS

• Revenue
  • File
• Managing Unsubscribes & Bounces
  • Introduction
• Anonymizing Personal Data (GDPR)
• Managing Hierarchy Levels
  • Introduction 
• Using 4.1 APIs
• Error Codes
  • HTTP Status Code Summary
  • Example of Error Message
  • Error Codes

Revenue

Use this API to add Revenue to Accounts in your CustomerGauge platform, and benefit from the many insights CustomerGauge offers.

File

• Revenue (GET/POST)

Managing Unsubscribes & Bounces

Introduction

These API methods allow you to add an e-mail address to unsubscribe, or retrieve a list of either bounced, or unsubscribed e-mail addresses.

 Unsubscribes

• GET Unsubscribe
• POST Unsubscribe

Bounces

• GET Bounce

Method type definition:

Get Method: Use this method to get (export) data from the CustomerGauge system.

Post Method: Use this method to upload (import) data to the CustomerGauge system.

Anonymizing Personal Data (GDPR)

To validate which records you're about to anonymize, use;

• GET Anonymize

To anonymize those records, use:

• POST Anonymize

Managing Hierarchy Levels

Introduction 

These API methods allow you to manage the hierarchy structure in your CustomerGauge system.

To retrieve your current hierarchy:

• GET Hierarchy

To add a new hierarchy level:

• POST Hierarchy

To update a hierarchy level:

• PUT Hierarchy

To delete a hierarchy level:

• DELETE Hierarchy

Using 4.1 APIs

The APIs in our 4.1 API Suite can be outputted in XML or JSON.

What do you need to get started?

1. Authentication

The recommended method of authentication is OAuth2. To authenticate through OAuth2, you'll need to use the Connected Apps (Setup → Integration → Connected Apps).

Unfortunately, some platforms do not support OAuth2 authentication to call (to them) external platforms. In those cases, you would need to leverage our Webhooks functionality.

2. General API URL (based on your location):

• EU server: https://api.eu.customergauge.com
• US server: https://api.us.customergauge.com
• AU server: https://api.au.customergauge.com

3. Method type definition:

• Get Method: Use this method to get (export) data from the CustomerGauge system.
• Post Method: Use this method to upload (import) data to the CustomerGauge system.
• Put Method: Use this method to update data already existing in the CustomerGauge system
• Delete Method: Use this method to delete data from the CustomerGauge System

{"Error":{"Message":"Record does not exist","Code":400002}}

<Error><Message>Record does not exist</Message><Code>400002</Code></Error>