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
OrganizationalUnit| Name | 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": "a045f111-040b-4f0b-b679-b033ad53b41a",
"Name": "sample string 2",
"ParentID": "9de8bf27-d124-415c-bf9e-af0234e55f98",
"ExternalID": "sample string 3"
}
application/x-www-form-urlencoded
Sample not available.
Response Information
Resource Description
HttpResponseMessage| Name | 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. |