Update an existing node

Request

Updates the name and tier on an existing node by custom_id.

Security

basic_auth

Path

custom_idstringrequired

custom_id of the Node.

curl -i -X PATCH \
  -u '<username>:<password>' \
  'https://docs.checkr.com/_mock/apis/openapi/nodes/{custom_id}'

Responses

Node

Bodyapplication/json

namestring, [ 1 .. 255 ] charactersrequired

The name for the node. This name will be displayed in the Checkr Dashboard.

Example:"Acme Staffing"

custom_idstring, [ 1 .. 255 ] charactersrequired

Customer-defined unique ID for the node. Must be unique within your account. Note: Custom IDs may contain only letters, numbers, spaces, hyphens, colons, ampersands, and/or underscores.

Example:"zpy8orej4r614ize"

tierstring, <= 255 characters

Customer-defined label for this level of the hierarchy. (For example "Department" or "Division".)

Example:"department"

parent_custom_idstring, <= 255 characters

The custom_id for the parent of this node. If not provided, this node will be placed at the top level of the hierarchy. Note: If provided, this node must be a valid and previously loaded custom_id, and may contain only letters, numbers, spaces, hyphens, colons, ampersands, and/or underscores.

Example:"parent custom id"

packagesArray of strings

List of slugs for packages that are visible to this node (through either direct assignment to the node, or assignment to one of the node's ancestors). Only provided if "include=packages" is included in the query.

Example:

[
  "driver_pro",
  "tasker_pro"
]

Response

{
  "name": "Acme Staffing",
  "custom_id": "zpy8orej4r614ize",
  "tier": "department",
  "parent_custom_id": "parent custom id",
  "packages": [
    "driver_pro",
    "tasker_pro"
  ]
}