FlowSettingsInput

Without church_id (your default), button_label and the three properties of customization (css, collected_fields, customize_churches) are required. With church_id, send only what the church changes. A property not listed here gets 400, and detail names the field to fix.

customization
Type: object
required

Appearance settings and declaration of donor fields your platform intends to prefill. Always sent; with church_id it can be empty, and what it omits comes from the partner default.

Properties: 3
expected_version
Type: integer
min:
0
required

The version from the settings you read (GET /v1/flow-settings, with the same church_id). If someone saved in the meantime, from the API or the partner portal, nothing is saved and you get 409 with the current settings and version.
brand_color
Type: string | null

Main brand color, written as a hash sign followed by six hexadecimal digits. Without church_id, omitting it (or sending null) removes the saved color and the donor flow uses its standard look. With church_id, omitting it uses the partner default.
button_label
Type: string
min length:
1
max length:
40

Text on the button in your own website that opens the donor flow. Required without church_id. With church_id, omit it to use the partner default.
church_id
Type: string
min length:
1

Church whose own appearance you save. Omit it to save the partner default. With it, only the properties you send are stored for the church; the rest follow the partner default.
cta_label
Type: string
min length:
1
max length:
40

Text on the continue button inside the Roster donor flow. Today the donor flow shows it only on the amount screen, and donor sessions you create start after that screen.
display_name
Type: string
min length:
1
max length:
40

Name of your platform shown to the donor, kept on one line: line breaks become a space and invisible characters are removed.
logo_url
Type: stringFormat: uri

HTTPS address of the logo image you host. Today the donor flow shows it only on the amount screen, and donor sessions you create start after that screen. A space or control character anywhere in the address is rejected, and the address is stored and returned in normalized form.
manage_url
Type: stringFormat: uri

HTTPS address of the page in your account area where donors change or cancel their gift; that page opens a manage session with roster.js. It must be on one of your registered sites. Emails to donors who came through you link there instead of to Roster. A space or control character anywhere in the address is rejected, and the address is stored and returned in normalized form. Workspace-level only: rejected with church_id.
support_contact
Type: stringFormat: email

Support email address shown to the donor.

AllowedOriginsInput

DonorSessionInput