Introduction

This API will update a hierarchy level (also known as "division") in your existing Hierarchy.


Feature notes:

  • The request should only contain 1 extra parameter. Ex: division + parent OR division + division_to_update.
  • When changing the division's parent, all of its child divisions will accompany it.



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

Resource Information

Response formatsJSON (default), XML
HTTP MethodPUT
Response familyHierarchy
HeaderAuthorization: api_key XXXXX


Resource URL

Europe Production Server: https://api.eu.customergauge.com/v4.1/hierarchy.json

US Production Server: https://api.us.customergauge.com/v4.1/hierarchy.json

Australia Production Server: https://api.au.customergauge.com/v4.1/hierarchy.json



How to call

PUT Data

Update data as key value.


Parameters

KeyDescriptionExample value
divisionThis is a required field.
The division you want to make changes to.
Amsterdam
division_to_updateThe new name for the divisionNorth Holland
parentThe new parent for the divisionNetherlands



Example Request

To call this API through cURL:

curl -H "Authorization: api_key XXXXX" -X PUT https://api.eu.customergauge.com/v4.1/hierarchy.json -d division=Amsterdam -d division_to_update="North Holland"


Example Result

Message reported on successful operation:

{
  "Data": {
    "message": "Division has been updated successfully"
  }
}


Message reported on failed operation:

{
  "Error": {
    "Message": "Required field 'id' not supplied",
    "Code": 300004
  }
}


Not the API you're looking for?

Related APIs:


Or view: