Update Component Properties

POST /sites/{site_id}/components/{component_id}/properties

Copy endpoint

https://api.webflow.com/v2

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

Parameters

path Path Parameters

Name	Type
`site_id` required Unique identifier for a Site	string
`component_id` required Unique identifier for a Component	string

query Query Parameters

Name	Type
`localeId` Unique identifier for a specific Locale. Lear more about localization.	string
`branchId` Scope the operation to work on a specific branch.	string

Request Body

application/json

{ properties: { propertyId: string;text: string; }[]; }

Responses

200 application/json

Request was successful

{ errors: string[]; }

Client Errors

400 application/json

Request body was incorrectly formatted.

{
code?: "bad_request" | "collection_not_found" | "conflict" | "duplicate_collection" | "duplicate_user_email" | "ecommerce_not_enabled" | "forbidden" | "forms_require_republish" | "incompatible_webhook_filter" | "internal_error" | "invalid_auth_version" | "invalid_credentials" | "invalid_domain" | "invalid_user_email" | "item_not_found" | "missing_scopes" | "no_domains" | "not_authorized" | "not_enterprise_plan_site" | "not_enterprise_plan_workspace" | "order_not_found" | "resource_not_found" | "too_many_requests" | "unsupported_version" | "unsupported_webhook_trigger_type" | "user_limit_reached" | "user_not_found" | "users_not_enabled" | "validation_error";
message?: string;
externalReference?: string;
details?: unknown[];
}

401 application/json

Provided access token is invalid or does not have access to requested resource

404 application/json

Requested resource not found

429 application/json

The rate limit of the provided access_token has been reached. Please have your application respect the X-RateLimit-Remaining header we include on API responses.

Server Errors

500 application/json

We had a problem with our server. Try again later.