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
Name | Description | Type | Additional 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
OrganizationalUnitName | Description | Type | Additional 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
{ "ID": "62b763ce-5622-4114-9148-bead869191e0", "Name": "sample string 2", "ParentID": "811b2203-9111-42bd-be1f-306313153439", "ExternalID": "sample string 3" }
application/x-www-form-urlencoded
Sample not available.
Response Information
Resource Description
HttpResponseMessageName | Description | Type | Additional information |
---|---|---|---|
Version | Version |
None. |
|
Content | HttpContent |
None. |
|
StatusCode | HttpStatusCode |
None. |
|
ReasonPhrase | string |
None. |
|
Headers | Collection of Object |
None. |
|
RequestMessage | HttpRequestMessage |
None. |
|
IsSuccessStatusCode | boolean |
None. |