updatePromotionFolder
put
/ccadmin/v1/promotionFolders/{id}
Update Promotion Folder. Update an existing promotion folder.
Request
Supported Media Types
- application/json
Path Parameters
-
id: string
Promotion folder ID corresponding to the promotion folder to be updated.
Root Schema : updatePromotionFolder_request
Type:
Show Source
object
-
name:
string
The name of the promotion folder.
-
parentFolder(optional):
object parentFolder
Map of promotion folder's repository ID key and value. In order to remove the folder assignment, set parentFolder to null e.g. "parentFolder": null
Example:
{
"parentFolder":{
"repositoryId":"promoFolder100001"
},
"name":"Winter Discount"
}
Nested Schema : parentFolder
Type:
object
Map of promotion folder's repository ID key and value. In order to remove the folder assignment, set parentFolder to null e.g. "parentFolder": null
Show Source
-
repositoryId(optional):
string
The promotion folder's repository ID
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Root Schema : updatePromotionFolder_response
Type:
Show Source
object
-
name(optional):
string
The name of the promotion folder.
-
parentFolder(optional):
object parentFolder
Parent Folder object of the current folder.
-
path(optional):
string
Promotion folder's absolute path, it is a concatenation of it's parent folder's names and it's own name separated by '/'
-
repositoryId(optional):
string
The promotion folder ID.
Nested Schema : parentFolder
Type:
object
Parent Folder object of the current folder.
Show Source
-
repositoryId(optional):
string
The promotion folder's repository ID
Example Response (application/json)
{
"path":"Holiday Discount/Winter Discount",
"parentFolder":{
"repositoryId":"promoFolder100001"
},
"name":"Winter Discount",
"repositoryId":"promoFolder10001"
}
412 Response
ETag mismatch. Asset has been updated by another user.
Default Response
The error response.
The following are the internal error codes thrown by this API when the request processing fails in Oracle Commerce Cloud:
|Error Code|Description|
|------------------|------------------|
|21247|Invalid format for parentFolder property|
|21246|Promotion folder cannot have a circular reference through it's parent folder|
|21245|Promotion folder cannot be added as a parent of itself|
|21244|No item found for the following type and ID: promotionFolder, invalidId|
|21243|Missing required property: name|
|21241|promotion folder not found for the given ID : nonExistingId|
|21240|Promotion folder ID is blank|
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