Form

Interface: Form

This interface was referenced by Config's JSON-Schema via the definition "forms".

Properties

confirmationMessage?

optional confirmationMessage: {[k: string]: unknown; root: { children: {[k: string]: unknown; type: any; version: number; }[]; direction: "rtl" | "ltr" | null; format: "" | "center" | "left" | "start" | "right" | "end" | "justify"; indent: number; type: string; version: number; }; } | null

Defined in: payload-types.ts:1819

confirmationType?

optional confirmationType: "redirect" | "message" | null

Defined in: payload-types.ts:1818

Choose whether to display an on-page message or redirect to a different page after they submit the form.

createdAt

createdAt: string

Defined in: payload-types.ts:1870

emails?

optional emails: { bcc?: string | null; cc?: string | null; emailFrom?: string | null; emailTo?: string | null; id?: string | null; message?: {[k: string]: unknown; root: { children: {[k: string]: unknown; type: any; version: number; }[]; direction: "rtl" | "ltr" | null; format: "" | "center" | "left" | "start" | "right" | "end" | "justify"; indent: number; type: string; version: number; }; } | null; replyTo?: string | null; subject: string; }[] | null

Defined in: payload-types.ts:1840

Send custom emails when the form submits. Use comma separated lists to send the same email to multiple recipients. To reference a value from this form, wrap that field's name with double curly brackets, i.e. {{firstName}}. You can use a wildcard {{}} to output all data and {{:table}} to format it as an HTML table in the email.

fields?

optional fields: ({ blockName?: string | null; blockType: "checkbox"; defaultValue?: boolean | null; id?: string | null; label?: string | null; name: string; required?: boolean | null; width?: number | null; } | { blockName?: string | null; blockType: "country_field"; id?: string | null; label?: string | null; name: string; required?: boolean | null; width?: number | null; } | { blockName?: string | null; blockType: "email"; id?: string | null; label?: string | null; name: string; placeholder?: string | null; required?: boolean | null; width?: number | null; } | { blockName?: string | null; blockType: "message"; id?: string | null; message?: {[k: string]: unknown; root: { children: {[k: string]: unknown; type: any; version: number; }[]; direction: "rtl" | "ltr" | null; format: "" | "center" | "left" | "start" | "right" | "end" | "justify"; indent: number; type: string; version: number; }; } | null; } | { blockName?: string | null; blockType: "number"; defaultValue?: number | null; id?: string | null; label?: string | null; name: string; required?: boolean | null; width?: number | null; } | { blockName?: string | null; blockType: "select"; defaultValue?: string | null; id?: string | null; label?: string | null; name: string; options?: { id?: string | null; label: string; value: string; }[] | null; placeholder?: string | null; required?: boolean | null; width?: number | null; } | { blockName?: string | null; blockType: "state"; id?: string | null; label?: string | null; name: string; required?: boolean | null; width?: number | null; } | { blockName?: string | null; blockType: "text"; defaultValue?: string | null; id?: string | null; label?: string | null; name: string; placeholder?: string | null; required?: boolean | null; width?: number | null; } | { blockName?: string | null; blockType: "textarea"; defaultValue?: string | null; id?: string | null; label?: string | null; name: string; required?: boolean | null; width?: number | null; })[] | null

Defined in: payload-types.ts:1703

id

id: string

Defined in: payload-types.ts:1701

redirect?

optional redirect: { url: string; }

Defined in: payload-types.ts:1834

url

url: string

submitButtonLabel?

optional submitButtonLabel: string | null

Defined in: payload-types.ts:1814

title

title: string

Defined in: payload-types.ts:1702

updatedAt

updatedAt: string

Defined in: payload-types.ts:1869