Skip to content

Create Label Template

POST
/v1/label-templates
curl --request POST \
--url https://example.com/api/v1/label-templates \
--header 'Authorization: <Authorization>' \
--header 'Content-Type: application/json' \
--data '{ "canvasData": {}, "description": "example", "dpi": 1, "height": 1, "isShared": true, "name": "example", "offsetX": 1, "offsetY": 1, "outputFormat": "png", "preset": "example", "sheetLayout": { "columns": 1, "gutterH": 1, "gutterV": 1, "marginLeft": 1, "marginTop": 1, "pageHeight": 1, "pageWidth": 1, "rows": 1 }, "width": 1 }'

Template Data

Media typeapplication/json
object
canvasData
object
key
additional properties
any
description
string
<= 1000 characters
dpi
integer
>= 72 <= 1200
height
required
number
<= 1000
isShared
boolean
name
required
string
>= 1 characters <= 255 characters
offsetX
number
>= -50 <= 50
offsetY
number
>= -50 <= 50
outputFormat
string
Allowed values: png pdf
preset
string
nullable
sheetLayout

SheetLayout overrides the preset’s page layout; null follows the preset

object
columns

Number of labels across

integer
>= 1 <= 50
gutterH

Horizontal gap between labels in mm

number
<= 500
gutterV

Vertical gap between labels in mm

number
<= 500
marginLeft

Left margin in mm

number
<= 500
marginTop

Top margin in mm

number
<= 500
pageHeight

Sheet height in mm (e.g., 279.4 for Letter, 297 for A4)

number
<= 1000
pageWidth

Sheet width in mm (e.g., 215.9 for Letter, 210 for A4)

number
<= 1000
rows

Number of labels down

integer
>= 1 <= 100
width
required
number
<= 1000

Created

Media typeapplication/json
object
canvasData
object
key
additional properties
any
createdAt
string
description
string
dpi
integer
height
number
id
string
isOwner
boolean
isShared
boolean
name
string
offsetX
number
offsetY
number
outputFormat
string
ownerId
string
preset
string
sheetLayout
object
columns

Number of labels across

integer
>= 1 <= 50
gutterH

Horizontal gap between labels in mm

number
<= 500
gutterV

Vertical gap between labels in mm

number
<= 500
marginLeft

Left margin in mm

number
<= 500
marginTop

Top margin in mm

number
<= 500
pageHeight

Sheet height in mm (e.g., 279.4 for Letter, 297 for A4)

number
<= 1000
pageWidth

Sheet width in mm (e.g., 215.9 for Letter, 210 for A4)

number
<= 1000
rows

Number of labels down

integer
>= 1 <= 100
updatedAt
string
width
number
Examplegenerated
{
"canvasData": {},
"createdAt": "example",
"description": "example",
"dpi": 1,
"height": 1,
"id": "example",
"isOwner": true,
"isShared": true,
"name": "example",
"offsetX": 1,
"offsetY": 1,
"outputFormat": "example",
"ownerId": "example",
"preset": "example",
"sheetLayout": {
"columns": 1,
"gutterH": 1,
"gutterV": 1,
"marginLeft": 1,
"marginTop": 1,
"pageHeight": 1,
"pageWidth": 1,
"rows": 1
},
"updatedAt": "example",
"width": 1
}