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
- 200
- 400
- 401
- 403
- 404
- 406
- 500
The updated Component Configuration.
Invalid parameters, form validation or save failure.
Missing or invalid API authentication.
Access denied by ACL.
Route, record or task not found.
Unsupported Accept header.
Model or server error.