Organizations - Update

Service:

IoT Central

API Version:

2022-07-31

Update an organization in the application via patch

PATCH https://{subdomain}.{baseDomain}/api/organizations/{organizationId}?api-version=2022-07-31

URI Parameters

Name	In	Required	Type	Description
baseDomain	path	True	string	The base domain for all Azure IoT Central service requests.
organizationId	path	True	string	Unique ID for the organization. Regex pattern: ^(?!-)[a-z0-9-]{1,48}[a-z0-9]$
subdomain	path	True	string	The application subdomain.
api-version	query	True	string	The version of the API being called.

Request Body

Media Types: "application/json", "application/merge-patch+json"

Name	Type	Description
body	object	Organization patch body.

Responses

Name	Type	Description
200 OK	Organization	Success
Other Status Codes	Error	An error response received from the IoT Central Service. Headers x-ms-error-code: string

Security

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

Update organization

Sample Request

HTTP

PATCH https://appsubdomain.azureiotcentral.com/api/organizations/seattle?api-version=2022-07-31

{
  "displayName": "Seattle",
  "parent": "washington"
}

Sample Response

Status code:

200

{
  "id": "seattle",
  "displayName": "Seattle",
  "parent": "washington"
}

Definitions

Name	Description
Error	The response error definition.
ErrorDetails	The detail information of the error.
Organization	The organization definition.

Error

The response error definition.

Name	Type	Description
error	ErrorDetails	Error details for current request.

ErrorDetails

The detail information of the error.

Name	Type	Description
code	string	Error code.
message	string	Error message details.
requestId	string	Correlation Id for current request.
time	string	The time that error request failed.

Organization

The organization definition.

Name	Type	Description
displayName	string	Display name of the organization.
id	string	Unique ID of the organization.
parent	string	ID of the parent of the organization.