This is an old documentation. Go to the latest Customer's Canvas docs

update Method


  • Updates a channel container with new parameters.

    // Initialize a product with the "card.psd" template and a channel container.
    const productDefinition = {
        surfaces: [{
            printAreas: [{
                designFile: "card",
                containers: [{
                    name: "foil",
                    type: "texture",
                    texture: "texture.jpg"
    // Load the editor.
    CustomersCanvas.IframeApi.loadEditor(iframe, productDefinition)
        // If the editor has been successfully loaded.
        .then(function (editor) {
            // When we get the product.
            editor.getProduct().then(function (product) {
                // Get the fourth container.
                    // Update this container with new parameters.
                        name: "SilverTexture",
                        texture: "silver-texture.jpg",
                        // Expects a translated string for the SILVER key in translations.json.
                        translationKey: "ObjectInspector.SILVER"


    Returns Promise < this >

    An instance of the updated container.