FormSubmitPayload

Result of formSubmit.

type FormSubmitPayload {
  success: Boolean!
  successMessage: String
  userErrors: [UserError!]!
}

Fields

FormSubmitPayload.success ● Boolean! non-null scalar

True when the submission was stored.

FormSubmitPayload.successMessage ● String scalar

Store-configured thank-you message, resolved to the request language; null when not configured.

FormSubmitPayload.userErrors ● [UserError!]! non-null object

Validation errors with stable codes: UNKNOWN_FIELD, REQUIRED_FIELD_MISSING, INVALID_OPTION, INVALID_VALUE, FORM_NOT_FOUND, FORM_INACTIVE. field carries the offending field key.

Returned By

formSubmit mutation