Put Tenant Branding

Put Tenant Branding

Sets the branding information including the portal name, portal color, selected theme and custom URLs for a specific org.

Request
URI
PUT
https://{api_host}/cloudapi/branding/tenant/{org}
COPY
Path Parameters
string
org
Required

Organization for whom branding is being set

string
org
Required

Organization for whom branding is being set

Request Body
UiBranding of type(s) application/json
Optional 
{
    "portalName": "string",
    "portalColor": "string",
    "selectedTheme": {
        "themeType": "string",
        "name": "string"
    },
    "customLinks": [
        {
            "name": "string",
            "menuItemType": "string",
            "url": "string"
        }
    ]
}
string
portalName
Required

portalName

string
portalColor
Optional

A custom color defined by the administrator and used to theme the site. The color should be in rgb hex color format such as "FFFFFF" all capitalized. Can be set to an empty string to use the selected theme's default colors.

UiTheme
selectedTheme
Optional

selectedTheme

array of UiBrandingMenuItem
customLinks
Required

customLinks

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns UiBranding of type(s) application/json;version=37.3 
{
    "portalName": "string",
    "portalColor": "string",
    "selectedTheme": {
        "themeType": "string",
        "name": "string"
    },
    "customLinks": [
        {
            "name": "string",
            "menuItemType": "string",
            "url": "string"
        }
    ]
}
string
portalName
Required

portalName

string
portalColor
Optional

A custom color defined by the administrator and used to theme the site. The color should be in rgb hex color format such as "FFFFFF" all capitalized. Can be set to an empty string to use the selected theme's default colors.

UiTheme
selectedTheme
Optional

selectedTheme

array of UiBrandingMenuItem
customLinks
Required

customLinks


Availability
Added in 32.0
Deprecated in 37.1
With alternative: see
See /cloudapi/1.0.0/brandingThemes
On This Page
Branding Operations
POST
Create Branding Theme
DELETE
Delete Branding Theme
DELETE
Delete Branding Theme Contents
DELETE
Delete System Icon
DELETE
Delete System Logo
DELETE
Delete Tenant Icon
DELETE
Delete Tenant Logo
GET
Get Branding Theme
GET
Get Branding Theme Css
GET
Get Branding Themes
GET
Get System Branding
GET
Get System Icon
GET
Get System Logo
GET
Get Tenant Branding
GET
Get Tenant Icon
GET
Get Tenant Logo
PUT
Put System Branding
PUT
Put System Icon
PUT
Put System Logo
PUT
Put Tenant Branding
PUT
Put Tenant Icon
PUT
Put Tenant Logo
DELETE
Remove Tenant Branding
PUT
Update Branding Theme
POST
Upload Branding Theme Contents