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

This endpoint updates content within a component defintion for secondary locales. It supports updating up to 1000 nodes in a single request.

Before making updates:

  1. Use the get component content endpoint to identify available content nodes and their types
  2. If your component definition has a component instance nested within it, retrieve the nested component instance's properties that you'll override using the get component properties endpoint
This endpoint is specifically for localizing component definitions. Ensure that the specified `localeId` is a valid **secondary locale** for the site otherwise the request will fail.

Required scope | components:write

Servers

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
nodes[] Array Yes

List of DOM Nodes with the new content that will be updated in each node.

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. 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.
  3. Click Test request to test run your request to the API and see the API's response.