Sign in

v4

latestOpenAPI 3.1.02026-07-3163216290.7 KB
Components

Update a component

Update a component's name and/or body. When the lmx body changes, the update cascades to every email using this component, and affectedEmailCount reports how many were affected. A change that would introduce a dynamic variable an email using the component cannot use is rejected.

post/v1/components/{componentId}

Request body

namestring
lmxstring

The component body as an LMX string.

Response

Successful.

idstring required

The ID of the component.

namestring required

The name of the component.

lmxstring required

The component body serialized as LMX.

affectedEmailCountnumber required

The number of emails using this component that were updated by the body change. 0 when only the name changed.

Example response

{
  "id": "clp2o4i6u8y0t5r3e1w7q9s1",
  "name": "Header",
  "lmx": "<Paragraph>Welcome to Acme</Paragraph>",
  "affectedEmailCount": 3
}