Skip to main content
POST
Import a library design

Authorizations

Authorization
string
header
required

A secret key from Print.App admin → Domains → Secret keys, sent as Authorization: Bearer sk_…. Server-side only.

Headers

Idempotency-Key
string

Makes a retry safe: a second request with the same key and the same body gets the first response back (for 24 hours) instead of creating the resource again. Use a new key, such as a UUID, for every new request.

Required string length: 1 - 255

Path Parameters

id
string
required

The library design id (design_…).

Body

application/json

Where the copy goes.

folderId
string

The design folder to put it in. Default root.

Required string length: 1 - 200
title
string

Its name in your account. Default: the library design's.

Required string length: 1 - 200

Response

Created.

A design (template) your customers start from. Open it in the editor with new PrintAppClient({ designId }).

object
string
required
Allowed value: "design"
id
string
required

The designId to pass to PrintAppClient.

title
string | null
required
unit
string | null
required

The unit the design is measured in: mm, cm, in, pt, px or ft.

pages
object[]
required
tags
string[]
required
connectorIds
string[]
required

The connectors the design runs on the product page.

resourceProfileIds
string[]
required

The resource profiles that limit what its editor offers.

pdfProfileId
string | null
required

The PDF profile its print PDF is made with; null: its own settings.

settings
object
required

The settings this design sets for itself, over the store's (see GET /v2/settings). Settings it doesn't set follow the store.

sceneId
string | null
required

The 3D scene the editor previews the design on (GET /v2/scenes); null: none.

created
string<date-time> | null
required
modified
string<date-time> | null
required