POST api/v1/OrganizationalUnits

Create a new Organizational Unit

Request Information

URI Parameters

NameDescriptionTypeAdditional information
fields

Use this to only return the data fields you're interested in. Field names not found are ignored and no error is thrown. If no fields are found then the full object is returned.

Collection of string

None.

suppressResponseCodes

Some applications do wonky things if error codes are used. Use this to force 200s to always return.

boolean

None.

APIKey

This is your unique key that identifies you as the developer of this app. Required for all calls.

string

None.

APIToken

This is the user's session token generated when you authenticate the user

string

None.

Body Parameters

The ID field is NOT needed for this as it will be generated by the server.

OrganizationalUnit
NameDescriptionTypeAdditional information
ID

The ID of the OU

globally unique identifier

None.

Name

The name of the OU

string

None.

ParentID

The ID of the parent OU. This will be null if this OU is a root OU.

globally unique identifier

None.

ExternalID

The external ID of the OU.

string

None.

Request Formats

application/json, text/json

Sample:
{
  "ID": "493fe6ef-4437-4f40-9deb-aa0872fbce61",
  "Name": "sample string 2",
  "ParentID": "965ab227-20eb-4432-a70a-52693d382a2d",
  "ExternalID": "sample string 3"
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

OrganizationalUnit
NameDescriptionTypeAdditional information
ID

The ID of the OU

globally unique identifier

None.

Name

The name of the OU

string

None.

ParentID

The ID of the parent OU. This will be null if this OU is a root OU.

globally unique identifier

None.

ExternalID

The external ID of the OU.

string

None.

Response Formats

application/json, text/json

Sample:
{
  "ID": "123913f0-50db-4d0c-99d0-04feb040adce",
  "Name": "sample string 2",
  "ParentID": "e994becc-fd33-49c5-996d-2547871add20",
  "ExternalID": "sample string 3"
}