Create organizationalBrandingLocalization

Namespace: microsoft.graph

Create a new organizationalBrandingLocalization object. This creates a localized branding and at the same time, the default branding if it doesn't exist.

The default branding is created only once. It's loaded when a localized branding isn't configured for the user's browser language. To retrieve the default branding, see Get branding.

This API is supported in the following national cloud deployments.

Global service US Government L4 US Government L5 (DOD) China operated by 21Vianet


One of the following permissions is required to call this API. To learn more, including how to choose permissions, see Permissions.

Permission type Permissions (from least to most privileged)
Delegated (work or school account) Organization.ReadWrite.All
Delegated (personal Microsoft account) Not supported.
Application Not supported.

HTTP request

This request creates a new localization branding and a default branding if one does not already exist.

POST /organization/{organizationId}/branding/localizations

Request headers

Name Description
Authorization Bearer {token}. Required.
Content-Type application/json. Required.

Request body

The following table shows the properties that are required when you create the organizationalBrandingLocalization object.

Property Type Description
id String An identifier that represents the locale specified using culture names. Culture names follow the RFC 1766 standard in the format "languagecode2-country/regioncode2", where "languagecode2" is a lowercase two-letter code derived from ISO 639-1 and "country/regioncode2" is an uppercase two-letter code derived from ISO 3166. For example, U.S. English is en-US. You can't create the default branding by setting the value of id to the String types 0 or default.

NOTE: Multiple branding for a single locale are currently not supported.


If successful, this method returns a 201 Created response code and an organizationalBrandingLocalization object in the response body.


The following example creates a branding localization for French (fr-FR) localization. Any unspecified properties of the String type inherit from the value in the default branding object. For example, if the signInPageText in the default branding object is null, the signInPageText for the fr-FR branding created in this request will also be null. To override a null value without any text, use a string containing only whitespace.


The following is an example of the request.

Content-Type: application/json

    "id": "fr-FR",
    "signInPageText": " "


The following is an example of the response.

HTTP/1.1 201 Created
Content-Type: application/json

    "@odata.context": "$metadata#organization('d69179bf-f4a4-41a9-a9de-249c0f2efb1d')/branding/localizations/$entity",
    "": "$/Microsoft.DirectoryServices.Organization('d69179bf-f4a4-41a9-a9de-249c0f2efb1d')//localizations/fr-FR",
    "id": "fr-FR",
    "backgroundColor": "",
    "backgroundImageRelativeUrl": null,
    "bannerLogoRelativeUrl": null,
    "cdnList": [],
    "signInPageText": " ",
    "squareLogoRelativeUrl": null,
    "usernameHintText": ""