This API allows you to add new hierarchy levels in your existing Hierarchy.

Good to know

API response format:

Our APIs return data in either JSON or XML format (depending on request by .json or .xml).

Deleting hierarchy nodes:

You can only delete the lowest hierarchy nodes (nodes without children).

Referencing deleted hierarchy nodes:

Prior to deletion, please make sure any hierarchy nodes you want to delete are not referenced on survey records, report filters, campaigns, etc.

Failure to do so will result (but may not be limited to) the following:

  • For survey records; records will only show up for Global users
  • Report filters; this filter value will be ignored
  • Campaigns; no match will be found with templates having the deleted hierarchy node

Creating hierarchy

Parent is not required but when is not chosen it will go to Global by default

About this API

Resource Information

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

Resource URL

Europe Production Server:

US Production Server:

Australia Production Server:

How to call


Post data as key value.


division (required)Amsterdam

Example Request

To call this API through cURL:

curl -H "Authorization: api_key XXXXX" -X POST -d division=Amsterdam -d parent=Netherlands

Example Result

Message reported on successful operation:

  "Data": {
    "id": "2"

Message reported on failed operation:

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

Not the API you're looking for?

Related APIs:

Or view: