PUT api/v1/OrganizationalUnits/{id}?suppressResponseCodes={suppressResponseCodes}&APIKey={APIKey}&APIToken={APIToken}

Allows the name or external ID (does NOT have to be unique, but likely should be...) of an OU to be updated. Will ignore other properties.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

The ID of the OU to update

globally unique identifier

Required

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

Do NOT use the ID field to select which OU you're updating. Choose the ID through the URL

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": "17e459b0-8df1-49f0-addf-724933516d2b",
  "Name": "sample string 2",
  "ParentID": "3f57f060-5822-4cf7-8198-fc5bff7a5a1a",
  "ExternalID": "sample string 3"
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

HttpResponseMessage
NameDescriptionTypeAdditional information
Version

Version

None.

Content

HttpContent

None.

StatusCode

HttpStatusCode

None.

ReasonPhrase

string

None.

Headers

Collection of Object

None.

RequestMessage

HttpRequestMessage

None.

IsSuccessStatusCode

boolean

None.