Update Branding Theme

PUT {{apiPath}}/environments/{{envID}}/themes/{{themeID}}

The PUT /environments/{{envID}}/themes/{{themeID}} endpoint updates the branding configuration theme associated with the specified theme ID.

Prerequisites

For property descriptions, see Branding theme data model.

PropertyTypeRequired?
configuration.backgroundColorStringRequired
configuration.backgroundTypeStringRequired
configuration.backgroundImage.hrefStringRequired
configuration.backgroundImage.idStringRequired
configuration.bodyTextColorStringOptional
configuration.buttonColorStringOptional
configuration.buttonTextColorStringOptional
configuration.cardColorStringOptional
configuration.footerStringOptional
configuration.headingTextColorStringOptional
configuration.linkTextColorStringOptional
configuration.logo.hrefStringRequired
configuration.logo.idStringRequired
configuration.logoTypeStringRequired
configuration.nameStringOptional
defaultBooleanRequired
templateStringRequired

Request Body

{"template"=>"default", "configuration"=>{"logoType"=>"IMAGE", "logo"=>{"href"=>"https://logo.com", "id"=>"{{logoID}}"}, "backgroundColor"=>"#333333", "backgroundType"=>"COLOR", "backgroundImage"=>{"href"=>"https://bg.com", "id"=>"{{imageID}}"}, "cardColor"=>"#333333", "headingTextColor"=>"#333333", "linkTextColor"=>"#333333", "bodyTextColor"=>"#444444", "buttonTextColor"=>"#333333", "buttonColor"=>"#333333", "name"=>"test theme", "footer"=>"Good for Copyright information."}}