Creating designs

Last updated on May 15, 2025
•
2-3 minutes to read

To add designs to storage, you can create or import them first. When creating the designs, you can configure the design properties through the API. The Customer's Canvas API allows for creating blank designs and designs based on mockups or external resources that appear as a background.

Blank designs are suitable for users who create their products from scratch. They are free to add any design elements when the working area is limited by the canvas size and a bleed area, with validation that all the elements fit this area.

The endpoint POST /api/processor/v1/designs/blank creates a design using basic settings and saves it to storage. The design name, path in storage, number of pages, and the page size are mandatory properties to be passed in the request body.

{
  "designParams": {
    "name": "Blank-letter",
    "path": "letters"
  },
  "blankDesignSettings": {
    "width": 792,
    "height": 612,
    "pages": 1
  }
}

Note that the folders specified in the path must already exist in storage. The width and height here are in pixels.

curl -X \
POST "https://api.customerscanvashub.com/api/processor/v1/designs/blank" \
-H  "accept: application/json" \
-H  "Authorization: Bearer <TOKEN>" \
-H  "Content-Type: application/json" \
-d  "{\"designParams\":{\"name\":\"Blank-letter\",\"path\":\"letters\"},\"blankDesignSettings\":{\"width\":792,\"height\":612,\"pages\":1}}"

POST https://api.customerscanvashub.com/api/processor/v1/designs/blank
{
  "designParams": {
    "name": "Blank-letter",
    "path": "letters"
  },
  "blankDesignSettings": {
    "width": 792,
    "height": 612,
    "pages": 1
  }
}

var tenantId = 12345; // Put your tenant ID here
// Put design settings here
var body = "{\"designParams\":{\"name\":\"Blank-letter\",\"path\":\"letters\"},\"blankDesignSettings\":{\"width\":792,\"height\":612,\"pages\":1}}";
var design = await designProcessorApiClient.CreateBlankDesignAsync(tenantId, body);

var tenantId = 12345; // Put your tenant ID here
// Put design settings here
var body = "{\"designParams\":{\"name\":\"Blank-letter\",\"path\":\"letters\"},\"blankDesignSettings\":{\"width\":792,\"height\":612,\"pages\":1}}";
var design = _designProcessorApiClient.createBlankDesign(tenantId, body);

$tenantId = 12345; // Put your tenant ID here
// Put design settings here
$body = "{\"designParams\":{\"name\":\"Blank-letter\",\"path\":\"letters\"},\"blankDesignSettings\":{\"width\":792,\"height\":612,\"pages\":1}}";
$design = $designProcessorApiClient->designProcessorCreateBlankDesign($tenantId, $body);

When you have 3D mockups in DAE format, you can use them to create designs to be rendered on the products they represent. The endpoint POST /api/processor/v1/designs/from-mockup creates a design based on a specified DAE mockup and saves it to storage. This endpoint does not require any design parameters, since they will be taken from the mockup.

{
  "designParams": {
    "name": "Paper-bag",
    "path": "packaging"
  },
  "mockupId": "6527afc63507abfadd355226"
}

The mandatory parameters are the design name, path, and mockup identifier.

curl -X \
POST "https://api.customerscanvashub.com/api/processor/v1/designs/from-mockup" \
-H  "accept: application/json" \
-H  "Authorization: Bearer <TOKEN>" \
-H  "Content-Type: application/json" \
-d  "{\"designParams\":{\"name\":\"Paper-bag\",\"path\":\"packaging\"},\"mockupId\":\"6527afc63507abfadd355226\"}"

POST https://api.customerscanvashub.com/api/processor/v1/designs/from-mockup
{
  "designParams": {
    "name": "Paper-bag",
    "path": "packaging"
  },
  "mockupId": "6527afc63507abfadd355226"
}

var tenantId = 12345; // Put your tenant ID here
// Put design settings here
var body = "{\"designParams\":{\"name\":\"Paper-bag\",\"path\":\"packaging\"},\"mockupId\":\"6527afc63507abfadd355226\"}";
var design = await designProcessorApiClient.CreateDesignFromMockupAsync(tenantId, body);

var tenantId = 12345; // Put your tenant ID here
// Put design settings here
var body = "{\"designParams\":{\"name\":\"Paper-bag\",\"path\":\"packaging\"},\"mockupId\":\"6527afc63507abfadd355226\"}";
var design = _designProcessorApiClient.createDesignFromMockup(tenantId, body);

$tenantId = 12345; // Put your tenant ID here
// Put design settings here
$body = "{\"designParams\":{\"name\":\"Paper-bag\",\"path\":\"packaging\"},\"mockupId\":\"6527afc63507abfadd355226\"}";
$design = $designProcessorApiClient->designProcessorCreateDesignFromMockup($tenantId, $body);

Further Reading

Learn how to import already created designs to storage.
Explore how to create and manage preview images using this API.
Dive into Asset Processor API reference.

Creating designs

Was this page helpful?