Update the Agent theme
put
/ccadmin/v1/themes/agentThemeDetails
Updates the styles and variables source code for the Agent theme. Returns all themes, including the non-agent themes.
Include any fields to be updated in request payload, as shown in below example. name
and notes
are always required in the payload. theme_styles_general
, theme_styles_typography
, theme_styles_color
and theme_additional_fonts
are required if the theme is of type custom.
Request
Supported Media Types
- application/json
Root Schema : updateTheme_request
Type:
Show Source
object
-
name:
string
Name of the theme.
-
notes:
string
Notes of the theme.
-
theme_additional_fonts(optional):
object theme_additional_fonts
A map of additional fonts of the theme.
-
theme_styles_color(optional):
object theme_styles_color
A map of color styles of the theme.
-
theme_styles_general(optional):
object theme_styles_general
A map of general styles of the theme.
-
theme_styles_typography(optional):
object theme_styles_typography
A map of typography styles of the theme.
Example:
{
"theme_additional_fonts":{
},
"notes":"test note",
"theme_styles_color":{
"@ButtonPrimarySize":"medium",
"@ButtonSecondaryTextDecoration":"none",
"@ButtonPrimaryTextColor":"#ffa403",
"@SubNavigationTextColor":"#ffa403",
"@ButtonPrimaryUseGradient":"false",
"@ButtonPrimaryFontStyle":"normal",
"@ButtonSecondaryFontFamily":"@sansFontFamily",
"@ButtonPrimaryFontWeight":"bold",
"@NavbarLinkColor":"#000000",
"@NavbarLinkHoverColor":"#000000",
"@NavbarTextColor":"#ffa403",
"@mobileNavBarButtonColor":"#333333",
"@SubNavigationLinkHoverColor":"#000000",
"@NavbarBackgroundHoverColor":"#ffffff",
"@ButtonSecondaryUseGradient":"false",
"@LinkVisitedColor":"#000000",
"@LinkColor":"#000000",
"@ButtonPrimaryBackgroundColor":"#000000",
"@NavbarBackgroundColor":"#ffffff",
"@SubNavigationLinkColor":"#ffa403",
"@ButtonPrimaryFontFamily":"@sansFontFamily",
"@ButtonPrimaryTextDecoration":"none",
"@ButtonSecondaryBorderRadius":"0px",
"@ButtonSecondaryFontStyle":"normal",
"@ButtonSecondaryTextColor":"#000000",
"@SubNavigationBackgroundColor":"#000000",
"@ButtonSecondaryFontWeight":"bold",
"@ButtonSecondaryBackgroundColor":"#eeeeee",
"@ButtonPrimaryBorderRadius":"0px",
"@LinkHoverColor":"#ffa403",
"@ButtonSecondarySize":"medium",
"@SubNavigationBackgroundHoverColor":"#000000",
"@TextColor":"#000000"
},
"theme_styles_typography":{
"@H6LineHeight":"150%",
"@H5TextDecoration":"inherit",
"@H3FontFamily":"inherit",
"@H5FontStyle":"inherit",
"@H2FontStyle":"inherit",
"@H2TextColor":"inherit",
"@SiteLineHeight":"150%",
"@SiteFontFamily":"@sansFontFamily",
"@H1TextAlign":"inherit",
"@ParagraphFontWeight":"normal",
"@H5FontSize":"1.00rem",
"@H4TextAlign":"inherit",
"@H1TextDecoration":"inherit",
"@H3LineHeight":"150%",
"@H2FontWeight":"bold",
"@H3FontSize":"1.75rem",
"@ParagraphLineHeight":"150%",
"@H3TextColor":"inherit",
"@H3TextAlign":"inherit",
"@H4FontFamily":"inherit",
"@SiteFontSize":"14px",
"@SiteTextAlign":"left",
"@H5FontWeight":"normal",
"@H6FontFamily":"inherit",
"@H1FontSize":"2.75rem",
"@H6FontStyle":"inherit",
"@H6TextDecoration":"inherit",
"@H2TextDecoration":"inherit",
"@ParagraphTextColor":"inherit",
"@H1FontStyle":"inherit",
"@ParagraphTextAlign":"inherit",
"@H4LineHeight":"150%",
"@H1FontWeight":"bold",
"@SiteTextColor":"#000000",
"@ParagraphFontSize":"1.00rem",
"@H5FontFamily":"inherit",
"@H4FontWeight":"bold",
"@ParagraphFontFamily":"inherit",
"@H1FontFamily":"inherit",
"@H2TextAlign":"inherit",
"@H1LineHeight":"150%",
"@H6FontSize":"0.85rem",
"@H3TextDecoration":"inherit",
"@H4TextColor":"inherit",
"@ParagraphFontStyle":"inherit",
"@ParagraphTextDecoration":"inherit",
"@H1TextColor":"inherit",
"@SiteTextDecoration":"none",
"@H4FontSize":"1.25rem",
"@SiteFontStyle":"normal",
"@H3FontWeight":"bold",
"@H6TextAlign":"inherit",
"@H4TextDecoration":"inherit",
"@H2FontFamily":"inherit",
"@H3FontStyle":"inherit",
"@SiteFontWeight":"normal",
"@H5LineHeight":"150%",
"@H2FontSize":"2.25rem",
"@H6TextColor":"inherit",
"@H4FontStyle":"inherit",
"@H2LineHeight":"150%",
"@H5TextColor":"inherit",
"@H5TextAlign":"inherit",
"@H6FontWeight":"normal"
},
"name":"testDarkThemeUpdate",
"theme_styles_general":{
"@SiteBackgroundImageAttachment":"scroll",
"@FooterBackgroundImageAttachment":"scroll",
"@FooterBorderTopColor":"#ffffff",
"@SBackgroundImageURL":"url(/file/media/odpfkokopfsd)",
"@SiteBackgroundImageURL":"url(/file/media/odpfkokopfsd)",
"@HeaderBackgroundUseGradient":"false",
"@SiteBackgroundColorBottom":"#000000",
"@HeaderTopBackgroundImageAttachment":"scroll",
"@HeaderTopBackgroundImagePosition":"top left",
"@HeaderTopBackgroundImageRepeat":"repeat-x",
"@HeaderTopPaddingTop":"25px",
"@FooterBackgroundColorBottom":"#ffffff",
"@HeaderTopBackgroundColorTop":"#ffffff",
"@HeaderBackgroundColorTop":"#ffffff",
"@HeaderTopBackgroundColor":"#ffffff",
"@HeaderBackgroundImageAttachment":"scroll",
"@FooterBackgroundImageURL":"none",
"@FooterBackgroundImageRepeat":"repeat-x",
"@SiteBackgroundImagePosition":"top left",
"@HeaderBackgroundImageRepeat":"repeat-x",
"@SiteBackgroundImageRepeat":"no-repeat",
"@FooterBackgroundUseGradient":"false",
"@HeaderTopBackgroundUseGradient":"false",
"@SiteBackgroundColorTop":"#000000",
"@HeaderBackgroundColorBottom":"#ffffff",
"@HeaderTopBackgroundColorBottom":"#ffffff",
"@HeaderBackgroundImagePosition":"top left",
"@SitePageBackgroundColor":"#ffffff",
"@HeaderTopBackgroundImageURL":"none",
"@HeaderTopBorderBottomColor":"#ffffff",
"@FooterBackgroundColorTop":"#ffffff",
"@HeaderBackgroundColor":"#ffffff",
"@HeaderBackgroundImageURL":"none",
"@SiteBackgroundColor":"#000000",
"@FooterBackgroundColor":"#ffffff",
"@SiteBackgroundUseGradient":"false",
"@FooterBackgroundImagePosition":"top left"
}
}
Nested Schema : theme_additional_fonts
Type:
object
A map of additional fonts of the theme.
Show Source
-
fontName(optional):
string
The additional font name.
-
fontValue(optional):
string
The additional font URL.
Nested Schema : theme_styles_color
Type:
object
A map of color styles of the theme.
Show Source
-
styleName(optional):
string
The style name.
-
styleValue(optional):
string
The style value.
Nested Schema : theme_styles_general
Type:
object
A map of general styles of the theme.
Show Source
-
styleName(optional):
string
The style name.
-
styleValue(optional):
string
The style value.
Nested Schema : theme_styles_typography
Type:
object
A map of typography styles of the theme.
Show Source
-
styleName(optional):
string
The style name.
-
styleValue(optional):
string
The style value.
Response
Supported Media Types
- application/json
200 Response
Returned when the operation succeeds.
Root Schema : updateTheme_response
Type:
Show Source
object
-
clone_parent_id(optional):
string
Clone parent id of the theme.
-
clone_parent_name(optional):
string
Clone parent name of the theme.
-
id(optional):
string
The ID of the theme.
-
is_active(optional):
boolean
Whether theme is active.
-
is_custom(optional):
boolean
Whether theme is custom or not.
-
name(optional):
string
Theme name.
-
notes(optional):
string
Notes of the theme.
-
repositoryId(optional):
string
Repository ID of the theme.
-
theme_styles_color(optional):
object theme_styles_color
Color information of theme styles.
-
theme_styles_general(optional):
object theme_styles_general
General information of theme styles.
-
theme_styles_typography(optional):
object theme_styles_typography
Typography information of theme styles.
-
thumbnail(optional):
string
Thumbnail image of the theme.
-
usingCodeView(optional):
boolean
Whether using code view or not.
Nested Schema : theme_styles_color
Type:
object
Color information of theme styles.
Show Source
-
@ButtonPrimaryBackgroundColor(optional):
string
Button Primary Background Color
-
@ButtonPrimaryBorderRadius(optional):
string
Button Primary Border Radius
-
@ButtonPrimaryFontFamily(optional):
string
Button Primary Font Family
-
@ButtonPrimaryFontStyle(optional):
string
Button Primary Font Style
-
@ButtonPrimaryFontWeight(optional):
string
Button Primary Font Weight
-
@ButtonPrimarySize(optional):
string
Button Primary Size
-
@ButtonPrimaryTextColor(optional):
string
-
@ButtonPrimaryTextDecoration(optional):
string
Button Primary Text Decoration
-
@ButtonPrimaryUseGradient(optional):
string
Button Primary Use Gradient
-
@ButtonSecondaryBackgroundColor(optional):
string
Button Secondary Background Color
-
@ButtonSecondaryBorderRadius(optional):
string
Button Secondary Border Radius
-
@ButtonSecondaryFontFamily(optional):
string
Button Secondary Font Family
-
@ButtonSecondaryFontStyle(optional):
string
Button Secondary Font Style
-
@ButtonSecondaryFontWeight(optional):
string
Button Secondary Font Weight
-
@ButtonSecondarySize(optional):
string
Button Secondary Size
-
@ButtonSecondaryTextColor(optional):
string
Button Secondary Text Color
-
@ButtonSecondaryTextDecoration(optional):
string
Button Secondary Text Decoration
-
@ButtonSecondaryUseGradient(optional):
string
Button Secondary Use Gradient
-
@LinkColor(optional):
string
Link Color
-
@LinkHoverColor(optional):
string
Link Hover Color
-
@LinkVisitedColor(optional):
string
Link Visited Color
- @mobileNavBarButtonColor(optional): string
- @NavbarBackgroundColor(optional): string
- @NavbarBackgroundHoverColor(optional): string
- @NavbarLinkColor(optional): string
- @NavbarLinkHoverColor(optional): string
- @NavbarTextColor(optional): string
- @SubNavigationBackgroundColor(optional): string
- @SubNavigationBackgroundHoverColor(optional): string
- @SubNavigationLinkColor(optional): string
- @SubNavigationLinkHoverColor(optional): string
- @SubNavigationTextColor(optional): string
-
@TextColor(optional):
string
Text Color
Nested Schema : theme_styles_general
Type:
object
General information of theme styles.
Show Source
- @FooterBackgroundColor(optional): string
- @FooterBackgroundColorBottom(optional): string
- @FooterBackgroundColorTop(optional): string
- @FooterBackgroundImageAttachment(optional): string
- @FooterBackgroundImagePosition(optional): string
- @FooterBackgroundImageRepeat(optional): string
- @FooterBackgroundImageURL(optional): string
- @FooterBackgroundUseGradient(optional): string
- @FooterBorderTopColor(optional): string
-
@HeaderBackgroundColor(optional):
string
Header Background Color
-
@HeaderBackgroundColorBottom(optional):
string
Header Background Color Bottom
-
@HeaderBackgroundColorTop(optional):
string
Header Background Color Top
-
@HeaderBackgroundImageAttachment(optional):
string
Header Background Image Attachment
-
@HeaderBackgroundImagePosition(optional):
string
Header Background Image Position
-
@HeaderBackgroundImageRepeat(optional):
string
Header Background Image Repeat
-
@HeaderBackgroundImageURL(optional):
string
Header Background Image URL
-
@HeaderBackgroundUseGradient(optional):
string
Header Background Use Gradient
-
@HeaderTopBackgroundColor(optional):
string
Header Top Background Color
-
@HeaderTopBackgroundColorBottom(optional):
string
Header Top Background Color Bottom
-
@HeaderTopBackgroundColorTop(optional):
string
Header Top Background Color Top
-
@HeaderTopBackgroundImageAttachment(optional):
string
Header Top Background Image Attachment
-
@HeaderTopBackgroundImagePosition(optional):
string
Header Top Background Image Position
-
@HeaderTopBackgroundImageRepeat(optional):
string
Header Top Background Image Repeat
-
@HeaderTopBackgroundImageURL(optional):
string
Header Top Background Image URL
-
@HeaderTopBackgroundUseGradient(optional):
string
Header Top Background Use Gradient
-
@HeaderTopBorderBottomColor(optional):
string
Header Top Border Bottom Color
-
@HeaderTopPaddingTop(optional):
string
Header Top Padding Top
-
@SiteBackgroundColor(optional):
string
Site Background Color
-
@SiteBackgroundColorBottom(optional):
string
Site Background Color Bottom
-
@SiteBackgroundColorTop(optional):
string
Site Background Color Top
-
@SiteBackgroundImageAttachment(optional):
string
Site Background Image Attachment
-
@SiteBackgroundImagePosition(optional):
string
Site Background Image Position
-
@SiteBackgroundImageRepeat(optional):
string
Site Background Image Repeat
-
@SiteBackgroundImageURL(optional):
string
Site Background Image URL
-
@SiteBackgroundUseGradient(optional):
string
Site Background Use Gradient
-
@SitePageBackgroundColor(optional):
string
Site Page Background Color
Nested Schema : theme_styles_typography
Type:
object
Typography information of theme styles.
Show Source
-
@H1FontFamily(optional):
string
Heading 1 Font Family
-
@H1FontSize(optional):
string
Heading 1 Font Size
-
@H1FontStyle(optional):
string
Heading 1 Font Style
-
@H1FontWeight(optional):
string
Heading 1 Font Weight
-
@H1LineHeight(optional):
string
Heading 1 Line Height
-
@H1TextAlign(optional):
string
Heading 1 Text Align
-
@H1TextColor(optional):
string
Heading 1 Text Color
-
@H1TextDecoration(optional):
string
Heading 1 Text Decoration
-
@H2FontFamily(optional):
string
Heading 2 Font Family
-
@H2FontSize(optional):
string
Heading 2 Font Size
-
@H2FontStyle(optional):
string
Heading 2 Font Style
-
@H2FontWeight(optional):
string
Heading 2 Font Weight
-
@H2LineHeight(optional):
string
Heading 2 Line Height
-
@H2TextAlign(optional):
string
Heading 2 Text Align
-
@H2TextColor(optional):
string
Heading 2 Text Color
-
@H2TextDecoration(optional):
string
Heading 2 Text Decoration
-
@H3FontFamily(optional):
string
Heading 3 Font Family
-
@H3FontSize(optional):
string
Heading 3 Font Size
-
@H3FontStyle(optional):
string
Heading 3 Font Style
-
@H3FontWeight(optional):
string
Heading 3 Font Weight
-
@H3LineHeight(optional):
string
Heading 3 Line Height
-
@H3TextAlign(optional):
string
Heading 3 Text Align
-
@H3TextColor(optional):
string
Heading 3 Text Color
-
@H3TextDecoration(optional):
string
Heading 3 Text Decoration
-
@H4FontFamily(optional):
string
Heading 4 Font Family
-
@H4FontSize(optional):
string
Heading 4 Font Size
-
@H4FontStyle(optional):
string
Heading 4 Font Style
-
@H4FontWeight(optional):
string
Heading 4 Font Weight
-
@H4LineHeight(optional):
string
Heading 4 Line Height
-
@H4TextAlign(optional):
string
Heading 4 Text Align
-
@H4TextColor(optional):
string
Heading 4 Text Color
-
@H4TextDecoration(optional):
string
Heading 4 Text Decoration
-
@H5FontFamily(optional):
string
Heading 5 Font Family
-
@H5FontSize(optional):
string
Heading 5 Font Size
-
@H5FontStyle(optional):
string
Heading 5 Font Style
-
@H5FontWeight(optional):
string
Heading 5 Font Weight
-
@H5LineHeight(optional):
string
Heading 5 Line Height
-
@H5TextAlign(optional):
string
Heading 5 Text Align
-
@H5TextColor(optional):
string
Heading 5 Text Color
-
@H5TextDecoration(optional):
string
Heading 5 Text Decoration
-
@H6FontFamily(optional):
string
Heading 6 Font Family
-
@H6FontSize(optional):
string
Heading 6 Font Size
-
@H6FontStyle(optional):
string
Heading 6 Font Style
-
@H6FontWeight(optional):
string
Heading 6 Font Weight
-
@H6LineHeight(optional):
string
Heading 6 Line Height
-
@H6TextAlign(optional):
string
Heading 6 Text Align
-
@H6TextColor(optional):
string
Heading 6 Text Color
-
@H6TextDecoration(optional):
string
Heading 6 Text Decoration
-
@ParagraphFontFamily(optional):
string
Paragraph Font Family
-
@ParagraphFontSize(optional):
string
Paragraph Font Size
-
@ParagraphFontStyle(optional):
string
Paragraph Font Style
-
@ParagraphFontWeight(optional):
string
Paragraph Font Weight
-
@ParagraphLineHeight(optional):
string
Paragraph Line Height
-
@ParagraphTextAlign(optional):
string
Paragraph Text Align
-
@ParagraphTextColor(optional):
string
Paragraph Text Color
-
@ParagraphTextDecoration(optional):
string
Paragraph Text Decoration
-
@SiteFontFamily(optional):
string
Site Font Family
-
@SiteFontSize(optional):
string
Site Font Size
-
@SiteFontStyle(optional):
string
Site Font Style
-
@SiteFontWeight(optional):
string
Site Font Weight
-
@SiteLineHeight(optional):
string
Site Line Height
-
@SiteTextAlign(optional):
string
Site Text Align
-
@SiteTextColor(optional):
string
Site Text Color
-
@SiteTextDecoration(optional):
string
Site Text Decoration
Example Response (application/json)
[
{
"isAgentTheme":false,
"thumbnail":null,
"theme_additional_fonts":{
},
"notes":"",
"is_active":false,
"usingCodeView":false,
"is_default":false,
"associatedSites":[
],
"clone_parent_name":"Dark Theme",
"repositoryId":"100001",
"name":"testClone",
"is_custom":true,
"id":"100001",
"clone_parent_id":"darkTheme",
"compilationStatuses":[
]
},
{
"isAgentTheme":true,
"thumbnail":null,
"theme_additional_fonts":{
},
"notes":"This is the Agent Theme.",
"is_active":false,
"usingCodeView":false,
"is_default":false,
"associatedSites":[
],
"clone_parent_name":"Cloud Lake Theme",
"repositoryId":"AgentTheme",
"name":"Agent Theme",
"is_custom":true,
"id":"AgentTheme",
"clone_parent_id":"100001",
"compilationStatuses":[
{
"occurredAt":"2020-04-07T15:20:27.000Z",
"repositoryId":"100002",
"siteId":null,
"details":null,
"id":"100002",
"status":101
}
]
},
{
"isAgentTheme":false,
"thumbnail":"/img/cloudlake.jpg",
"theme_additional_fonts":{
},
"notes":"test",
"is_active":false,
"usingCodeView":false,
"is_default":false,
"associatedSites":[
],
"clone_parent_name":null,
"repositoryId":"cloudLakeTheme",
"name":"Cloud Lake Theme",
"is_custom":false,
"id":"cloudLakeTheme",
"clone_parent_id":null,
"compilationStatuses":[
]
},
{
"isAgentTheme":false,
"thumbnail":null,
"theme_additional_fonts":{
},
"notes":"test note",
"is_active":true,
"usingCodeView":false,
"is_default":true,
"associatedSites":[
{
"repositoryId":"siteUS",
"name":"Commerce Cloud Site"
}
],
"clone_parent_name":"Cloud Lake Theme",
"repositoryId":"darkTheme",
"name":"testDarkThemeUpdate",
"is_custom":true,
"id":"darkTheme",
"clone_parent_id":"100001",
"compilationStatuses":[
{
"occurredAt":"2020-05-26T14:39:54.956Z",
"repositoryId":"200001",
"siteId":"siteUS",
"details":"",
"id":"200001",
"status":101
}
]
},
{
"isAgentTheme":false,
"thumbnail":null,
"theme_additional_fonts":{
},
"notes":null,
"is_active":false,
"usingCodeView":false,
"is_default":false,
"associatedSites":[
],
"clone_parent_name":"Cloud Lake Theme",
"repositoryId":"monoTheme",
"name":"Mono Theme",
"is_custom":true,
"id":"monoTheme",
"clone_parent_id":"100001",
"compilationStatuses":[
]
}
]
Default Response
The following are the internal error codes thrown by this API when the request processing fails in Oracle Commerce Cloud:
The error response:
Error Code | Description | Possible Fix |
---|---|---|
70004 | Specified theme does not exist. | Ensure you have specified a valid theme ID. |
70008 | Attempted to assign theme a non-unique name. | Ensure the new theme name is not in use. |
70009 | Internal error whilst updating theme. | See returned error messages for further information. |
70021 | Internal error retrieving theme. | See returned error messages for more information. |
70026 | No agent theme exists on the system. | An agent theme needs to be created. |
The error response:
Root Schema : errorModel
Type:
Show Source
object
-
devMessage(optional):
string
An optional non-localized message containing technical information for developers
-
errorCode(optional):
string
The numerical code identifying the error
-
errors(optional):
array errors
An optional list of errors if multiple errors were encountered
-
message(optional):
string
The localized message describing the error
-
moreInfo(optional):
string
An optional non-localized message with more information
-
o:errorPath(optional):
string
An optional machine readable description of where the error occurred
-
status(optional):
string
The HTTP status code
-
type(optional):
string
The URI to the HTTP state code definition
Nested Schema : errors
Type:
array
An optional list of errors if multiple errors were encountered
Show Source
Nested Schema : items
Type:
Show Source
object
-
devMessage(optional):
string
An optional non-localized message containing technical information for developers
-
errorCode(optional):
string
The numerical code identifying the error
-
message(optional):
string
The localized message describing the error
-
moreInfo(optional):
string
An optional non-localized message with more information
-
o:errorPath(optional):
string
An optional machine readable description of where the error occurred
-
status(optional):
string
The HTTP status code