Jump to

• Request
• Response

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.

Body ()

Root Schema : updatePromotionFolder_request

Type: object

Show Source

• 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

{
    "properties":{
        "parentFolder":{
            "description":"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",
            "type":"object",
            "properties":{
                "repositoryId":{
                    "description":"The promotion folder's repository ID",
                    "type":"string"
                }
            }
        },
        "name":{
            "description":"The name of the promotion folder.",
            "type":"string"
        }
    },
    "required":[
        "name"
    ],
    "example":{
        "parentFolder":{
            "repositoryId":"promoFolder100001"
        },
        "name":"Winter Discount"
    }
}

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

{
    "description":"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",
    "type":"object",
    "properties":{
        "repositoryId":{
            "description":"The promotion folder's repository ID",
            "type":"string"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Following model is returned when operation succeeds.

Body ()

Root Schema : updatePromotionFolder_response

Type: object

Show Source

• 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.

{
    "properties":{
        "path":{
            "description":"Promotion folder's absolute path, it is a concatenation of it's parent folder's names and it's own name separated by '/'",
            "type":"string"
        },
        "parentFolder":{
            "description":"Parent Folder object of the current folder. ",
            "type":"object",
            "properties":{
                "repositoryId":{
                    "description":"The promotion folder's repository ID",
                    "type":"string"
                }
            }
        },
        "repositoryId":{
            "description":"The promotion folder ID.",
            "type":"string"
        },
        "name":{
            "description":"The name of the promotion folder.",
            "type":"string"
        }
    }
}

Nested Schema : parentFolder

Type: object

Parent Folder object of the current folder.

Show Source

• repositoryId(optional): string
  The promotion folder's repository ID

{
    "description":"Parent Folder object of the current folder. ",
    "type":"object",
    "properties":{
        "repositoryId":{
            "description":"The promotion folder's repository ID",
            "type":"string"
        }
    }
}

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

• 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

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "type":{
            "description":"The URI to the HTTP state code definition",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "errors":{
            "description":"An optional list of errors if multiple errors were encountered",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "errorCode":{
                        "description":"The numerical code identifying the error",
                        "type":"string"
                    },
                    "message":{
                        "description":"The localized message describing the error",
                        "type":"string"
                    },
                    "devMessage":{
                        "description":"An optional non-localized message containing technical information for developers",
                        "type":"string"
                    },
                    "moreInfo":{
                        "description":"An optional non-localized message with more information",
                        "type":"string"
                    },
                    "o:errorPath":{
                        "description":"An optional machine readable description of where the error occurred",
                        "type":"string"
                    },
                    "status":{
                        "description":"The HTTP status code",
                        "type":"string"
                    }
                }
            }
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Nested Schema : errors

Type: array

An optional list of errors if multiple errors were encountered

Show Source

• Array of: object items

{
    "description":"An optional list of errors if multiple errors were encountered",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "errorCode":{
                "description":"The numerical code identifying the error",
                "type":"string"
            },
            "message":{
                "description":"The localized message describing the error",
                "type":"string"
            },
            "devMessage":{
                "description":"An optional non-localized message containing technical information for developers",
                "type":"string"
            },
            "moreInfo":{
                "description":"An optional non-localized message with more information",
                "type":"string"
            },
            "o:errorPath":{
                "description":"An optional machine readable description of where the error occurred",
                "type":"string"
            },
            "status":{
                "description":"The HTTP status code",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• 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

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Back to Top