POST /sites/{site_id}/components/{component_id}/properties
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.
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
Servers
- https://api.webflow.com/v2
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
site_id |
String | Yes |
Unique identifier for a Site |
component_id |
String | Yes |
Unique identifier for a Component |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
localeId |
String | No |
Unique identifier for a specific locale. Applicable, when using localization. |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
properties[] |
Array | Yes |
A list of component properties to update within the specified secondary locale. |
properties[].text |
String | Yes |
The new string or HTML value used to update the component property in the secondary locale. The provided value must be compatible with the type of the component property. For example, attempting to update a single-line plain-text property with a multi-line value will result in an error. |
properties[].propertyId |
String | Yes |
The ID of the property. |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.