Create, edit or copy a label template
Creates or changes a bottle/cap label template. Omit template to create (name; size default 19×19 mm round with the beer name and style). Pass template (id or name) to change only the given fields; elements replaces all elements. duplicate: true copies the template (name = the copy's name). Sizes in mm (5-100); text elements use placeholders like {{name}} that print each brew's values (see get_labels). Needs the plan feature `labels`. Scope: `cellar:write` (or `write`).
Creates or changes a bottle/cap label template. Omit template to create (name; size default 19×19 mm round with the beer name and style). Pass template (id or name) to change only the given fields; elements replaces all elements. duplicate: true copies the template (name = the copy's name). Sizes in mm (5-100); text elements use placeholders like {{name}} that print each brew's values (see get_labels).
Needs the plan feature labels. Scope: cellar:write (or write).
API token in format: bfk_. Each operation lists the token scope it requires (the scopes are listed below).
read: Read everything (all areas)write: Create, change and delete everything (all areas)brews:read: List and view brewsbrews:write: Create, update, delete brews and notesinventory:read: List inventory itemsinventory:write: Create, update, delete inventory itemsequipment:read: List equipment profilesequipment:write: Create, update, delete equipment profilesstyles:read: List style profilesstyles:write: Create, update, delete style profilesprofiles:read: List mash, fermentation, and water profilescustom-fields:read: List custom field definitionscustom-fields:write: Create, update, delete custom field definitionsprofiles:write: Create, update, delete mash, fermentation, and water profilescellar:read: View cellar, packaged stock, tap lists, and labelscellar:write: Manage cellar, packaging, stock, tap lists, and labelssettings:read: View preferences, imports, calculators, and your data exportsettings:write: Change preferences and undo importscommunity:read: View community, feedback, tickets, inbox, and account overviewcommunity:write: Post, vote, and reply in community, feedback, and tickets
In: header
Scope: cellar:write
Request Body
application/json
Change (or with duplicate, copy) this template: id or exact name. Omit to create.
true = copy template instead of changing it.
Name, e.g. "Crown cap 26 mm". Required to create.
1 <= length <= 100Label width in mm, e.g. 26.
5 <= value <= 100Label height in mm.
5 <= value <= 100round (caps) or rectangle.
"round" | "rectangle"All elements of the label, e.g. [{"id":"1","content":"{{name}}","x":13,"y":10,"font_size_pt":9,"bold":true}].
items <= 50Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://brewforge.sh/api/v1/actions/save_label_template" \ -H "Content-Type: application/json" \ -d '{}'{
"created": true,
"template": {
"id": "string",
"name": "string",
"width_mm": 0,
"height_mm": 0,
"shape": "string",
"elements": [
{
"type": "text",
"id": "string",
"content": "string",
"x": 100,
"y": 100,
"font_family": "string",
"font_size_pt": 4,
"bold": true,
"align": "left",
"width_mm": 1,
"height_mm": 1
}
]
}
}{
"error": {
"code": "string",
"message": "string",
"hint": "string",
"candidates": [
{
"id": "string",
"name": "string"
}
],
"fields": {
"property1": [
"string"
],
"property2": [
"string"
]
},
"details": {}
}
}{
"error": {
"code": "string",
"message": "string",
"hint": "string",
"candidates": [
{
"id": "string",
"name": "string"
}
],
"fields": {
"property1": [
"string"
],
"property2": [
"string"
]
},
"details": {}
}
}{
"error": {
"code": "string",
"message": "string",
"hint": "string",
"candidates": [
{
"id": "string",
"name": "string"
}
],
"fields": {
"property1": [
"string"
],
"property2": [
"string"
]
},
"details": {}
}
}{
"error": {
"code": "string",
"message": "string",
"hint": "string",
"candidates": [
{
"id": "string",
"name": "string"
}
],
"fields": {
"property1": [
"string"
],
"property2": [
"string"
]
},
"details": {}
}
}{
"error": {
"code": "string",
"message": "string",
"hint": "string",
"candidates": [
{
"id": "string",
"name": "string"
}
],
"fields": {
"property1": [
"string"
],
"property2": [
"string"
]
},
"details": {}
}
}{
"error": {
"code": "string",
"message": "string",
"hint": "string",
"candidates": [
{
"id": "string",
"name": "string"
}
],
"fields": {
"property1": [
"string"
],
"property2": [
"string"
]
},
"details": {}
}
}