Skip to main content

Update Component Configuration

PATCH 

/v1/config/:component_name

Update configuration data of a component.

GET returns a collection in which each resource contains one setting in attributes. Page through all results when taking a baseline. PATCH merges component options with their existing values before validating the selected form. A successful configuration PATCH does not return the updated configuration: an empty JSON array is possible. Read the options again. Global component options and options on individual articles are separate settings. SMTP smtpauth accepts 0, 1 or 2 (disabled, password or OAuth 2.0), including numeric strings; REST writes do not perform browser OAuth consent. The base edit check requires core.manage and record core.edit, or core.edit.own with a matching owner; component overrides take precedence. Omitted SERVER_UTC/USER_UTC calendar values are restored from the stored UTC values after validation, avoiding a second timezone conversion.

Request​

Responses​

The updated Component Configuration.