updatePromotionFolder

put

/ccadmin/v1/promotionFolders/{id}

Update Promotion Folder. Update an existing promotion folder.

Request

Supported Media Types
Path Parameters
  • Promotion folder ID corresponding to the promotion folder to be updated.
Body ()
Root Schema : updatePromotionFolder_request
Type: object
Show Source
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
Back to Top

Response

Supported Media Types

200 Response

Following model is returned when operation succeeds.
Body ()
Root Schema : updatePromotionFolder_response
Type: object
Show Source
Nested Schema : parentFolder
Type: object
Parent Folder object of the current folder.
Show Source
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|
Body ()
Root Schema : errorModel
Type: object
Show Source
Nested Schema : errors
Type: array
An optional list of errors if multiple errors were encountered
Show Source
Nested Schema : items
Type: object
Show Source
Back to Top