v1

latestOpenAPI 3.1.0Copyright Pismo2026-07-247702,7523.1 MB

Hierarchies

Create hierarchy

Creates a hierarchy. This can be used generically, but it's typically used to create business hierarchies along territorial lines: headquarters > countries > regions > branches, and so on.

This endpoint generates a Corporate hierarchy created event. See the Data and reporting guide for more information on events and setting up event notifications.

For more information on hierarchies, see Hierarchy.

post/corporate/v1/hierarchies

Request body

namestring required

Hierarchy name

Example request

{
  "name": "string",
  "levels": [
    {
      "name": "string",
      "index": 0,
      "description": "string"
    }
  ]
}

Response

Created

idstring uuid required

Hierarchy ID generated internally

namestring

Hierarchy One

Example response

{
  "levels": [
    {
      "index": 2
    }
  ]
}