Update Component Properties

POST

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

Before making updates:

  1. Use the get component properties endpoint to identify available properties
The request requires a secondary locale ID. If a locale is missing, the request will not be processed and will result in an error.

Required scope | components:write

Path parameters

site_idstringRequired

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.

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