Introduction

You can use this API to integrate your systems to Add or Update Accounts inside your CustomerGauge platform.

You can also add additional Account Properties such as Account Manager, Parent Account and Reporting Region that can soon be filtered upon — be ready for the near future!


Good to know

Authentication through OAuth2 only

We only support OAuth2 authentication on this API.


Reference is also the Account Name:

The provided reference will be mapped to Account Name, and displayed throughout the platform as such.


API response format:

This API returns data in JSON format


About this API

Resource Information

Response formatsJSON
HTTP MethodPUT
Response familyContracts
HeaderAuthorization: Bearer XXXXX (Access Token)


Resource URL

Europe Production Server: https://imports.api.eu.customergauge.com/accounts

US Production Server: https://imports.api.us.customergauge.com/accounts

Australia Production Server: https://imports.api.au.customergauge.com/accounts


How to call

PUT Data

Provide the data, in JSON, in the body of the PUT request.


Parameters

While the data should provided in a JSON object in the body of the PUT request, we've listed out the possibilities in the table below;


Key
Data Type
Data
reference (this also serves as Account Name)
Required. String, max 128 characters
ACME Industries
number
String, max 255 characters123
manager
String, max 128 characters
John Doe
parent
String, max 128 characters
ACME Group
region
String, max 128 characters
EMEA



Example Request

To call this API through cURL:

curl  -H "Authorization: Bearer XXXXX" -X PUT https://imports.api.eu.customergauge.com/accounts -d '{"reference":"ACME Industries","number":"123","manager":"John Doe,"parent":"ACME Group","region":"EMEA"}'


Example Result

If successfully created, the HTTP response status will be "201".

If successfully updated, the HTTP response status will be "200".


Message reported on failed operation:

{
	"message": "The given data was invalid.",
	"errors": {
		"reference": [
			"reference is required."
		]
	}
}


Not the API you're looking for?

View: