Update Hierarchy

put

https://api.beauthenticx.com/Hierarchy/{HierarchyId}

Updates information about an existing hierarchy in your organization.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

⚠️
Note:
If you want to update contacts with this call, you will need the User Id values for any users you want to assign.
Providing any contact list field is a full replacement, not a merge. To add a user to an existing list, include all current contact IDs plus the new one.

Path Params

HierarchyId

uuid

required

UUID of the hierarchy to update

Body Params

name

string | null

The new name of the hierarchy you intend to change.

category

string | null

A new category for your hierarchy used by your organization.

subCategory

string | null

A new subcategory for your hierarchy used by your organization.

code

string | null

A new id or value used by your organization.

administrativeContactsUserIds

array of strings | null

Replaces the full list of administrative contacts. If omitted, existing contacts are preserved.

administrativeContactsUserIds

escalationContactsUserIds

array of strings | null

Replaces the full list of escalation contacts. If omitted, existing contacts are preserved.

escalationContactsUserIds

managerContactsUserIds

array of strings | null

Replaces the full list of manager contacts. If omitted, existing contacts are preserved.

managerContactsUserIds

newParentId

string | null

UUID of a new parent hierarchy. Pass the string "remove" to detach from current parent and promote to top-level node.

isActive

boolean | null

Set to false to deactivate the hierarchy.

hierarchyCodes

array of strings | null

Replaces the full list of source system codes. If omitted, existing codes are preserved.

hierarchyCodes

Responses

400

Bad Request

404

If your organization has no hierarchy with that specific id

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 updated Hierarchy, and the name of its parent if applicable