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
- See Branding and Branding Themes for important overview information.
For property descriptions, see Branding theme data model.
Property | Type | Required? |
---|---|---|
configuration.backgroundColor | String | Required |
configuration.backgroundType | String | Required |
configuration.backgroundImage.href | String | Required |
configuration.backgroundImage.id | String | Required |
configuration.bodyTextColor | String | Optional |
configuration.buttonColor | String | Optional |
configuration.buttonTextColor | String | Optional |
configuration.cardColor | String | Optional |
configuration.footer | String | Optional |
configuration.headingTextColor | String | Optional |
configuration.linkTextColor | String | Optional |
configuration.logo.href | String | Required |
configuration.logo.id | String | Required |
configuration.logoType | String | Required |
configuration.name | String | Optional |
default | Boolean | Required |
template | String | Required |
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."}}