Create Hierarchy

post

https://api.beauthenticx.com/Hierarchy

Adds a hierarchy to your organization.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

⚠️
Note:
Your organization must have at least one structure level configured before you can create hierarchies. The number of structure levels determines how many tiers of parent/child nesting your hierarchy supports.

Common next steps after a POST /Hierarchy/ call:

Use the returned Id as HierarchyId when uploading interactions
Use the returned Id as osms when creating or updating agents
Create child nodes by calling POST /Hierarchy/ again with this node's Id as ParentId

Body Params

name

string

required

length ≥ 1

Display name for the new hierarchy node.

category

string | null

Organizational category label.

subCategory

string | null

Organizational subcategory label.

code

string | null

A short internal code for this node used by your organization.

administrativeContactsUserIds

array of strings | null

List of User Id strings to assign as administrative contacts.

administrativeContactsUserIds

escalationContactsUserIds

array of strings | null

List of User Id strings to assign as escalation contacts.

escalationContactsUserIds

managerContactsUserIds

array of strings | null

List of User Id strings to assign as manager contacts.

managerContactsUserIds

hierarchyCodes

array of strings | null

List of string codes from your source system that map to this hierarchy. Used when uploading interactions by code rather than ID.

hierarchyCodes

parentId

uuid | null

Id of an existing hierarchy to nest this node under. Omit to create a top-level node.

Responses

400

One of the following errors occurred: No hierarchy name was provided in the request body, a ParentId was provided but no hierarchy exists with that id
within your organization, a valid ParentId was provided but you don't have enough structure levels for the new hierarchy,
your organization has no structure levels, a user id in the provided contact lists is invalid.

Language

Credentials

OAuth2

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

Note:

200Returns the newly created Hierarchy, and the name of its parent if applicable