/v1/labels/{id} (PATCH)
PATCH
/v1/labels/{id}
const url = 'https://example.com/v1/labels/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0';const options = { method: 'PATCH', headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'}, body: '{"name":"example","internal_name":"example","name_line_2":"example","name_line_3":"example","name_line_2_small":true,"name_line_3_small":true,"vintage":"example","is_non_vintage":true,"brand_id":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0","quantity":1,"gtin":"example","consumer_product_variant":"example","lot":"example","internal_reference":"example","locale":"example","label_design":"example","color":"example","product_type":"example","sweetness":"example","country_of_origin_id":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0","single_vineyard_id":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0","production_method_id":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0","packaging_gas":"example","bottler_id":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0","distributor_id":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0","ppwr_importer_id":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0","ppwr_manufacturer_id":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0","producer_number_only":true,"bottler_number_only":true,"distributor_number_only":true,"hide_producer":true,"hide_bottler":true,"hide_distributor":true,"hide_ppwr_importer":true,"hide_ppwr_manufacturer":true,"hide_conformity_declaration":true,"alcohol":1,"alcohol_label":1,"residual_sugar":1,"sugar":1,"acidity":1,"glycerin":1,"energy_kcal":1,"energy_kj":1,"fat":1,"fat_negligible":true,"saturated_fat":1,"carbohydrates":1,"carbohydrates_negligible":true,"protein":1,"protein_negligible":true,"salt":1,"salt_negligible":true,"portion_size":1,"calculate_manually":true,"summarize_small_amounts":true,"use_gs1_digital_link":true,"use_recycling_regulations":true,"show_allergen_text":true,"show_inspection_number":true,"show_product_type":true,"show_quantity":true,"show_sweetness":true,"inspection_number":"example","organic_certificate_number":"example","minimum_durability_date":"example","dealcoholisation_applied":true,"dealcoholisation_status":"example","marketing_link_type":"example","marketing_link_href":"example","outside_eu_forward_href":"example","scan_with_glasswise_href":"example","scan_with_glasswise_forward_href":"example","image_id":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0","image_orientation":"example","original_image_id":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0","data_sheet_file_id":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0","inspection_report_id":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0","primary_brand_asset_id":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0","default_format_id":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0","notes":"example","is_archived":true}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request PATCH \ --url https://example.com/v1/labels/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "name": "example", "internal_name": "example", "name_line_2": "example", "name_line_3": "example", "name_line_2_small": true, "name_line_3_small": true, "vintage": "example", "is_non_vintage": true, "brand_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "quantity": 1, "gtin": "example", "consumer_product_variant": "example", "lot": "example", "internal_reference": "example", "locale": "example", "label_design": "example", "color": "example", "product_type": "example", "sweetness": "example", "country_of_origin_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "single_vineyard_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "production_method_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "packaging_gas": "example", "bottler_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "distributor_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "ppwr_importer_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "ppwr_manufacturer_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "producer_number_only": true, "bottler_number_only": true, "distributor_number_only": true, "hide_producer": true, "hide_bottler": true, "hide_distributor": true, "hide_ppwr_importer": true, "hide_ppwr_manufacturer": true, "hide_conformity_declaration": true, "alcohol": 1, "alcohol_label": 1, "residual_sugar": 1, "sugar": 1, "acidity": 1, "glycerin": 1, "energy_kcal": 1, "energy_kj": 1, "fat": 1, "fat_negligible": true, "saturated_fat": 1, "carbohydrates": 1, "carbohydrates_negligible": true, "protein": 1, "protein_negligible": true, "salt": 1, "salt_negligible": true, "portion_size": 1, "calculate_manually": true, "summarize_small_amounts": true, "use_gs1_digital_link": true, "use_recycling_regulations": true, "show_allergen_text": true, "show_inspection_number": true, "show_product_type": true, "show_quantity": true, "show_sweetness": true, "inspection_number": "example", "organic_certificate_number": "example", "minimum_durability_date": "example", "dealcoholisation_applied": true, "dealcoholisation_status": "example", "marketing_link_type": "example", "marketing_link_href": "example", "outside_eu_forward_href": "example", "scan_with_glasswise_href": "example", "scan_with_glasswise_forward_href": "example", "image_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "image_orientation": "example", "original_image_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "data_sheet_file_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "inspection_report_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "primary_brand_asset_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "default_format_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "notes": "example", "is_archived": true }'Update scalar label fields. Omitted keys are untouched, explicit null clears a nullable field. Publish state changes only through the publish endpoint.
Authorizations
Section titled “Authorizations”Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters”id
required
string format: uuid
Request Bodyrequired
Section titled “Request Bodyrequired”Media typeapplication/json
object
name
string
internal_name
string | null
name_line_2
string | null
name_line_3
string | null
name_line_2_small
boolean | null
name_line_3_small
boolean | null
vintage
string | null
is_non_vintage
boolean
brand_id
string | null format: uuid
quantity
number | null
gtin
string | null
consumer_product_variant
string | null
lot
string | null
internal_reference
string | null
locale
string | null
label_design
string | null
color
string | null
product_type
string | null
sweetness
string | null
country_of_origin_id
string | null format: uuid
single_vineyard_id
string | null format: uuid
production_method_id
string | null format: uuid
packaging_gas
string | null
bottler_id
string | null format: uuid
distributor_id
string | null format: uuid
ppwr_importer_id
string | null format: uuid
ppwr_manufacturer_id
string | null format: uuid
producer_number_only
boolean | null
bottler_number_only
boolean | null
distributor_number_only
boolean | null
hide_producer
boolean | null
hide_bottler
boolean | null
hide_distributor
boolean | null
hide_ppwr_importer
boolean | null
hide_ppwr_manufacturer
boolean | null
hide_conformity_declaration
boolean | null
alcohol
number | null
alcohol_label
number | null
residual_sugar
number | null
sugar
number | null
acidity
number | null
glycerin
number | null
energy_kcal
number | null
energy_kj
number | null
fat
number | null
fat_negligible
boolean | null
saturated_fat
number | null
carbohydrates
number | null
carbohydrates_negligible
boolean | null
protein
number | null
protein_negligible
boolean | null
salt
number | null
salt_negligible
boolean | null
portion_size
number | null
calculate_manually
boolean | null
summarize_small_amounts
boolean | null
use_gs1_digital_link
boolean | null
use_recycling_regulations
boolean | null
show_allergen_text
boolean | null
show_inspection_number
boolean | null
show_product_type
boolean | null
show_quantity
boolean | null
show_sweetness
boolean | null
inspection_number
string | null
organic_certificate_number
string | null
minimum_durability_date
string | null
dealcoholisation_applied
boolean | null
dealcoholisation_status
string | null
marketing_link_type
string | null
marketing_link_href
string | null
outside_eu_forward_href
string | null
scan_with_glasswise_href
string | null
scan_with_glasswise_forward_href
string | null
image_id
string | null format: uuid
image_orientation
string | null
original_image_id
string | null format: uuid
data_sheet_file_id
string | null format: uuid
inspection_report_id
string | null format: uuid
primary_brand_asset_id
string | null format: uuid
default_format_id
string | null format: uuid
notes
string | null
is_archived
boolean
Examplegenerated
{ "name": "example", "internal_name": "example", "name_line_2": "example", "name_line_3": "example", "name_line_2_small": true, "name_line_3_small": true, "vintage": "example", "is_non_vintage": true, "brand_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "quantity": 1, "gtin": "example", "consumer_product_variant": "example", "lot": "example", "internal_reference": "example", "locale": "example", "label_design": "example", "color": "example", "product_type": "example", "sweetness": "example", "country_of_origin_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "single_vineyard_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "production_method_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "packaging_gas": "example", "bottler_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "distributor_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "ppwr_importer_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "ppwr_manufacturer_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "producer_number_only": true, "bottler_number_only": true, "distributor_number_only": true, "hide_producer": true, "hide_bottler": true, "hide_distributor": true, "hide_ppwr_importer": true, "hide_ppwr_manufacturer": true, "hide_conformity_declaration": true, "alcohol": 1, "alcohol_label": 1, "residual_sugar": 1, "sugar": 1, "acidity": 1, "glycerin": 1, "energy_kcal": 1, "energy_kj": 1, "fat": 1, "fat_negligible": true, "saturated_fat": 1, "carbohydrates": 1, "carbohydrates_negligible": true, "protein": 1, "protein_negligible": true, "salt": 1, "salt_negligible": true, "portion_size": 1, "calculate_manually": true, "summarize_small_amounts": true, "use_gs1_digital_link": true, "use_recycling_regulations": true, "show_allergen_text": true, "show_inspection_number": true, "show_product_type": true, "show_quantity": true, "show_sweetness": true, "inspection_number": "example", "organic_certificate_number": "example", "minimum_durability_date": "example", "dealcoholisation_applied": true, "dealcoholisation_status": "example", "marketing_link_type": "example", "marketing_link_href": "example", "outside_eu_forward_href": "example", "scan_with_glasswise_href": "example", "scan_with_glasswise_forward_href": "example", "image_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "image_orientation": "example", "original_image_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "data_sheet_file_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "inspection_report_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "primary_brand_asset_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "default_format_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "notes": "example", "is_archived": true}Responses
Section titled “ Responses ”The updated label
Media typeapplication/json
object
id
required
string format: uuid
workspace_id
required
string format: uuid
brand_id
required
string | null format: uuid
ref
required
string | null
name
required
string
internal_name
required
string | null
name_line_2
required
string | null
name_line_3
required
string | null
name_line_2_small
required
boolean | null
name_line_3_small
required
boolean | null
vintage
required
string | null
is_non_vintage
required
boolean
quantity
required
Fill volume in MILLILITRES, e.g. 750 or 1500
number | null
gtin
required
string | null
consumer_product_variant
required
string | null
lot
required
string | null
internal_reference
required
string | null
locale
required
string | null
label_design
required
string | null
color
required
string | null
product_type
required
string | null
sweetness
required
string | null
country_of_origin_id
required
string | null format: uuid
single_vineyard_id
required
string | null format: uuid
production_method_id
required
string | null format: uuid
packaging_gas
required
string | null
bottler_id
required
string | null format: uuid
distributor_id
required
string | null format: uuid
ppwr_importer_id
required
string | null format: uuid
ppwr_manufacturer_id
required
string | null format: uuid
producer_number_only
required
boolean | null
bottler_number_only
required
boolean | null
distributor_number_only
required
boolean | null
hide_producer
required
boolean | null
hide_bottler
required
boolean | null
hide_distributor
required
boolean | null
hide_ppwr_importer
required
boolean | null
hide_ppwr_manufacturer
required
boolean | null
hide_conformity_declaration
required
boolean | null
alcohol
required
number | null
alcohol_label
required
number | null
residual_sugar
required
number | null
sugar
required
number | null
acidity
required
number | null
glycerin
required
number | null
energy_kcal
required
number | null
energy_kj
required
number | null
fat
required
number | null
fat_negligible
required
boolean | null
saturated_fat
required
number | null
carbohydrates
required
number | null
carbohydrates_negligible
required
boolean | null
protein
required
number | null
protein_negligible
required
boolean | null
salt
required
number | null
salt_negligible
required
boolean | null
portion_size
required
number | null
calculate_manually
required
boolean | null
summarize_small_amounts
required
boolean | null
use_gs1_digital_link
required
boolean | null
use_recycling_regulations
required
boolean | null
show_allergen_text
required
boolean | null
show_inspection_number
required
boolean | null
show_product_type
required
boolean | null
show_quantity
required
boolean | null
show_sweetness
required
boolean | null
inspection_number
required
string | null
organic_certificate_number
required
string | null
minimum_durability_date
required
string | null
dealcoholisation_applied
required
boolean | null
dealcoholisation_status
required
string | null
marketing_link_type
required
string | null
marketing_link_href
required
string | null
outside_eu_forward_href
required
string | null
scan_with_glasswise_href
required
string | null
scan_with_glasswise_forward_href
required
string | null
image_id
required
string | null format: uuid
image_orientation
required
string | null
original_image_id
required
string | null format: uuid
data_sheet_file_id
required
string | null format: uuid
inspection_report_id
required
string | null format: uuid
primary_brand_asset_id
required
string | null format: uuid
notes
required
string | null
is_published
required
boolean
is_archived
required
boolean
published_at
required
string | null
short_url
required
string | null
short_url_marketing
required
string | null
default_format_id
required
string | null format: uuid
created_at
required
string | null
updated_at
required
string | null
formats
required
Array<object>
object
id
required
string format: uuid
label_id
required
string format: uuid
ref
required
string | null
quantity
required
Fill volume in MILLILITRES, e.g. 750 or 1500
number | null
gtin
required
string | null
consumer_product_variant
required
string | null
lot
required
string | null
internal_reference
required
string | null
shop_url
required
string | null
short_url
required
string | null
available_from
required
string | null
image_id
required
string | null format: uuid
created_at
required
string | null
updated_at
required
string | null
translations
required
Array<object>
object
locale
required
string
description
required
string | null
description_full
required
string | null
designation_of_origin
required
string | null
origin
required
string | null
region
required
string | null
quality
required
string | null
sensory_description
required
string | null
aroma
required
string | null
serving_temperature
required
string | null
harvest_date
required
string | null
age_of_the_vines
required
string | null
soil
required
string | null
yield_per_hectare
required
string | null
maturation
required
string | null
aging_potential
required
string | null
single_vineyard
required
string | null
allergen_text
required
string | null
custom_ingredients
required
string | null
message_certifications
required
string | null
message_food_pairing
required
string | null
message_geographical
required
string | null
message_organic
required
string | null
message_production_method
required
string | null
message_recycling
required
string | null
message_responsible_consumption
required
string | null
message_sustainability
required
string | null
Examplegenerated
{ "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "workspace_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "brand_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "ref": "example", "name": "example", "internal_name": "example", "name_line_2": "example", "name_line_3": "example", "name_line_2_small": true, "name_line_3_small": true, "vintage": "example", "is_non_vintage": true, "quantity": 1, "gtin": "example", "consumer_product_variant": "example", "lot": "example", "internal_reference": "example", "locale": "example", "label_design": "example", "color": "example", "product_type": "example", "sweetness": "example", "country_of_origin_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "single_vineyard_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "production_method_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "packaging_gas": "example", "bottler_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "distributor_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "ppwr_importer_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "ppwr_manufacturer_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "producer_number_only": true, "bottler_number_only": true, "distributor_number_only": true, "hide_producer": true, "hide_bottler": true, "hide_distributor": true, "hide_ppwr_importer": true, "hide_ppwr_manufacturer": true, "hide_conformity_declaration": true, "alcohol": 1, "alcohol_label": 1, "residual_sugar": 1, "sugar": 1, "acidity": 1, "glycerin": 1, "energy_kcal": 1, "energy_kj": 1, "fat": 1, "fat_negligible": true, "saturated_fat": 1, "carbohydrates": 1, "carbohydrates_negligible": true, "protein": 1, "protein_negligible": true, "salt": 1, "salt_negligible": true, "portion_size": 1, "calculate_manually": true, "summarize_small_amounts": true, "use_gs1_digital_link": true, "use_recycling_regulations": true, "show_allergen_text": true, "show_inspection_number": true, "show_product_type": true, "show_quantity": true, "show_sweetness": true, "inspection_number": "example", "organic_certificate_number": "example", "minimum_durability_date": "example", "dealcoholisation_applied": true, "dealcoholisation_status": "example", "marketing_link_type": "example", "marketing_link_href": "example", "outside_eu_forward_href": "example", "scan_with_glasswise_href": "example", "scan_with_glasswise_forward_href": "example", "image_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "image_orientation": "example", "original_image_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "data_sheet_file_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "inspection_report_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "primary_brand_asset_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "notes": "example", "is_published": true, "is_archived": true, "published_at": "example", "short_url": "example", "short_url_marketing": "example", "default_format_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "created_at": "example", "updated_at": "example", "formats": [ { "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "label_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "ref": "example", "quantity": 1, "gtin": "example", "consumer_product_variant": "example", "lot": "example", "internal_reference": "example", "shop_url": "example", "short_url": "example", "available_from": "example", "image_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "created_at": "example", "updated_at": "example" } ], "translations": [ { "locale": "example", "description": "example", "description_full": "example", "designation_of_origin": "example", "origin": "example", "region": "example", "quality": "example", "sensory_description": "example", "aroma": "example", "serving_temperature": "example", "harvest_date": "example", "age_of_the_vines": "example", "soil": "example", "yield_per_hectare": "example", "maturation": "example", "aging_potential": "example", "single_vineyard": "example", "allergen_text": "example", "custom_ingredients": "example", "message_certifications": "example", "message_food_pairing": "example", "message_geographical": "example", "message_organic": "example", "message_production_method": "example", "message_recycling": "example", "message_responsible_consumption": "example", "message_sustainability": "example" } ]}Invalid body
Media typeapplication/problem+json
object
type
required
string
title
required
string
status
required
number
detail
string
Examplegenerated
{ "type": "example", "title": "example", "status": 1, "detail": "example"}Missing or invalid bearer token
Media typeapplication/problem+json
object
type
required
string
title
required
string
status
required
number
detail
string
Examplegenerated
{ "type": "example", "title": "example", "status": 1, "detail": "example"}Label not found or not writable
Media typeapplication/problem+json
object
type
required
string
title
required
string
status
required
number
detail
string
Examplegenerated
{ "type": "example", "title": "example", "status": 1, "detail": "example"}Upstream error
Media typeapplication/problem+json
object
type
required
string
title
required
string
status
required
number
detail
string
Examplegenerated
{ "type": "example", "title": "example", "status": 1, "detail": "example"}