FlowSettingsResponse
- settingsType: object | nullrequiredProperties: 8
The saved settings in the same shape
PUT /v1/flow-settingsaccepts, so you can read them, change a field and save them back. Null means no settings have been saved. For a church, this is the appearance in effect for it (its overrides on top of your default); to change the church, editchurch_settingsinstead. - skinType: object | nulldeprecatedrequiredProperties: 8
Deprecated — read
settings. The same settings with camelCase names, kept for integrations built beforesettingsexisted. Null means no settings have been saved. - versionType: integermin:0required
Version of these settings: 0 before the first save, then one more on every save, from the API or the partner portal. Saved settings never read 0: settings saved before versions were counted read 1. Send it back as
expected_versionwhen you save. Withchurch_id, the version of that church's own settings; a change to your default does not change it. - churchType: settings
_settings Properties: 8Only with
church_id: what that church itself stores, in the shapePUT /v1/flow-settingsaccepts withchurch_id. Null means the church follows your default as is. A save withchurch_idreplaces this whole object: apply your change to it and send it back withversionasexpected_version. - removedType: array of string
Only in the response to
PUT /v1/flow-settings, where it is always present: the properties that were saved before the request and are not saved after it, named by their path in the request body, such asdisplay_nameorcustomization.css.padding. Withoutchurch_id, compared with your previous default; withchurch_id, with what the church stored before. A property whose value changed is not listed. Empty when the save removed nothing. If it lists a property you meant to keep, save again with it.