Domains - Update Domain

Service:

Admin

API Version:

v1

Updates the specified domain info.

Note

This API is a release version of a preview version due to be deprecated on March 31, 2026. When calling this API - callers must set the query parameter preview to the value false

Permissions

The caller must be a Fabric administrator.

Required Delegated Scopes

Tenant.ReadWrite.All.

Limitations

Maximum 25 requests per one minute per principal.

Microsoft Entra supported identities

This API supports the Microsoft identities listed in this section.

Identity	Support
User	Yes
Service principal and Managed identities	Yes

Interface

PATCH https://api.fabric.microsoft.com/v1/admin/domains/{domainId}?preview={preview}

URI Parameters

Name	In	Required	Type	Description
domainId	path	True	string (uuid)	The domain ID.
preview	query	True	boolean	This parameter specifies which version of the API to use. Set to false to use the release version.

Request Body

Name	Type	Description
defaultLabelId	string (uuid)	The domain default sensitivity label. To remove the defaultLabelId from a domain, set its value to an empty UUID in your request: "00000000-0000-0000-0000-000000000000".
description	string	The domain description. The description cannot contain more than 256 characters.
displayName	string	The domain display name. The display name cannot contain more than 40 characters.

Responses

Name	Type	Description
200 OK	Domain	Request completed successfully.
Other Status Codes	ErrorResponse	Common error codes: UnknownError - An error occurred. EntityConflict - Update domain failed because domain display name already exists.

Examples

Update a domain example

Sample request

HTTP

PATCH https://api.fabric.microsoft.com/v1/admin/domains/97dd1d38-a4c6-41ed-bc4f-1e383f8ddd0f?preview=false

{
  "displayName": "Domain's new name",
  "description": "Domain's new description",
  "defaultLabelId": "d9a6c724-a08f-429d-9fa9-9659c5181b7f"
}

Sample response

Status code:

200

{
  "id": "f2f6a374-789e-4d1d-9cc7-6e0b934fc529",
  "displayName": "Domain's new name",
  "description": "Domain's new description",
  "parentDomainId": null,
  "defaultLabelId": "d9a6c724-a08f-429d-9fa9-9659c5181b7f"
}

Definitions

Name	Description
Domain
ErrorRelatedResource	The error related resource details object.
ErrorResponse	The error response.
ErrorResponseDetails	The error response details.
UpdateDomainRequest

Domain

Object

Name	Type	Description
defaultLabelId	string (uuid)	The domain default sensitivity label.
description	string	The description of the domain.
displayName	string	The name of the domain.
id	string (uuid)	The domain object ID.
parentDomainId	string (uuid)	The domain parent object ID.

ErrorRelatedResource

Object

The error related resource details object.

Name	Type	Description
resourceId	string	The resource ID that's involved in the error.
resourceType	string	The type of the resource that's involved in the error.

ErrorResponse

Object

The error response.

Name	Type	Description
errorCode	string	A specific identifier that provides information about an error condition, allowing for standardized communication between our service and its users.
message	string	A human readable representation of the error.
moreDetails	ErrorResponseDetails[]	List of additional error details.
relatedResource	ErrorRelatedResource	The error related resource details.
requestId	string	ID of the request associated with the error.

ErrorResponseDetails

Object

The error response details.

Name	Type	Description
errorCode	string	A specific identifier that provides information about an error condition, allowing for standardized communication between our service and its users.
message	string	A human readable representation of the error.
relatedResource	ErrorRelatedResource	The error related resource details.

UpdateDomainRequest

Object

Name	Type	Description
defaultLabelId	string (uuid)	The domain default sensitivity label. To remove the defaultLabelId from a domain, set its value to an empty UUID in your request: "00000000-0000-0000-0000-000000000000".
description	string	The domain description. The description cannot contain more than 256 characters.
displayName	string	The domain display name. The display name cannot contain more than 40 characters.