Skip to main content

settingsSaveEntity

Overview​

Updates configuration settings for an entity. Supports saving multiple settings atomically with automatic schema validation.

Behavior​

All settings are validated before any changes persist. If validation fails for any setting, the entire operation is rejected (all-or-nothing). Settings can contain any JSON-serializable data. If a schema exists for a key, the value must conform to it.

Keys cannot contain dots; use nested JSON structures instead.

To retrieve updated settings with full metadata and options, use the settingsByEntity query after successful mutation.

Permissions​

Requires settings:save_* permission for the entity type.

settingsSaveEntity(
  input: SaveEntitySettingsInput!
): SaveEntitySettingsPayload

Arguments​

settingsSaveEntity.input ● SaveEntitySettingsInput! non-null input​

Parameters for SaveEntitySettings

Type​

SaveEntitySettingsPayload object​

Autogenerated return type of SaveEntitySettings.