Update Component Properties

1 from webflow import Webflow 2 from webflow.resources.components import ComponentPropertiesWritePropertiesItem 3 4 client = Webflow( 5 access_token="YOUR_ACCESS_TOKEN", 6 ) 7 client.components.update_properties( 8 site_id="580e63e98c9a982ac9b8b741", 9 component_id="8505ba55-ef72-629e-f85c-33e4b703d48b", 10 locale_id="65427cf400e02b306eaa04a0", 11 branch_id="68026fa68ef6dc744c75b833", 12 properties=[ 13 ComponentPropertiesWritePropertiesItem( 14 property_id="a245c12d-995b-55ee-5ec7-aa36a6cad623", 15 text="The Hitchhiker’s Guide to the Galaxy", 16 ), 17 ComponentPropertiesWritePropertiesItem( 18 property_id="a245c12d-995b-55ee-5ec7-aa36a6cad627", 19 text="<div><h3>Dont Panic!</h3><p>Always know where your towel is.</p></div>", 20 ), 21 ], 22 )

Update the default property values of a component definition in a specificed locale.

Before making updates:

Use the get component properties endpoint to identify properties that can be updated in a secondary locale.
Rich Text properties may include a data-w-id attribute. This attribute is used by Webflow to maintain links across locales. Always include the original data-w-id value in your update requests to ensure consistent behavior across all locales.

The request requires a secondary locale ID. If a localeId is missing, the request will not be processed and will result in an error.

Required scope | components:write

Update the default property values of a component definition in a specificed locale. Before making updates: 1. Use the [get component properties](/data/reference/pages-and-components/components/get-properties) endpoint to identify properties that can be updated in a secondary locale. 2. Rich Text properties may include a `data-w-id` attribute. This attribute is used by Webflow to maintain links across locales. Always include the original `data-w-id` value in your update requests to ensure consistent behavior across all locales. <Note>The request requires a secondary locale ID. If a `localeId` is missing, the request will not be processed and will result in an error.</Note> Required scope | `components:write`

Path parameters

site_idstringRequiredformat: "objectid"

Unique identifier for a Site

component_idstringRequired

Unique identifier for a Component

Query parameters

localeIdstringOptional

Unique identifier for a specific locale. Applicable, when using localization.

branchIdstringOptionalformat: "objectid"

Scope the operation to work on a specific branch.

Request

This endpoint expects an object.

propertieslist of objectsRequired

A list of component properties to update within the specified secondary locale.

Response

Request was successful

errorslist of strings

A list of error messages, if any.

Path parameters

Headers

Query parameters

Request

Response

Errors

1	{
2	"errors": []
3	}