Pages and ComponentsComponents

Update Component Properties

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

Before making updates:

  1. Use the get component 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.
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

Path parameters

site_idstringRequiredformat: "objectid"
Unique identifier for a Site
component_idstringRequired
Unique identifier for a Component

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

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.

Errors