Set theme as the active agent theme.
post
/ccadmin/v1/themes/{id}/setAsAgentTheme
Set a particular theme as the active agent theme (as given by the supplied id).
Request
Supported Media Types
- application/json
Path Parameters
-
id: string
The ID of the theme.
Response
Supported Media Types
- application/json
200 Response
Returned when the operation succeeds.
Root Schema : setAsAgentTheme_response
Type:
Show Source
object
-
status(optional):
boolean
Has the theme been set as active.
Example Response (application/json)
{
"status":true
}
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 |
---|---|---|
70000 | Internal server error. | See returned error messages for more information. | 70004 | Theme does not exist. | Ensure theme exists. |
70021 | Theme retrieval failed. | See returned error message for further information. |
70028 | Error setting agent theme. | See returned error message for further information. |
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