UpdateFormInput

Attributes of a form to change; omitted attributes keep their current value

type UpdateFormInput {
  async_callback_actions: String
  async_callback_delay: String
  async_callback_max_attempts: Int
  async_callback_priority: AsyncCallbackPriority
  authorization_policy_ids: [ID!]
  callback_actions: String
  configuration: HashObject
  default_payload: String
  flash_alert: String
  flash_notice: String
  liquid_body: String
  metadata: HashObject
  name: String
  physical_file_path: String
  redirect_to: String
  resource: String
  resource_owner: String
  response_headers: String
  spam_protection: SpamProtectionInput
}

Fields

async_callback_actions (String)

Liquid code run in a background job after the data is saved

async_callback_delay (String)

Liquid code rendering to the number of minutes async_callback_actions are delayed by

async_callback_max_attempts (Int)

Maximum number of attempts of async_callback_actions when they fail

async_callback_priority (AsyncCallbackPriority)

Priority of the async_callback_actions background job

authorization_policy_ids (ID)

Ids of authorization policies checked before the form is shown or submitted

callback_actions (String)

Liquid code run right after the data is saved; prefer async_callback_actions

configuration (HashObject)

Allowlist of attributes that can be saved; submitted values are available in
callbacks and notifications through the form variable, for example
form.properties.my_var

default_payload (String)

Liquid code rendering to JSON merged over the submitted input before
validation, for values users must not set themselves, such as
context.current_user.id

flash_alert (String)

Liquid code rendering to the message shown when validation fails, available as context.flash_alert

flash_notice (String)

Liquid code rendering to the message shown after a successful submission, available as context.flash_notice

liquid_body (String)

Liquid code rendering the form HTML; the form_builder variable and the form tag are available

metadata (HashObject)

Arbitrary JSON data stored with the form

name (String)

Deprecated, derived from physical_file_path. Name of the form

physical_file_path (String)

Path of the file the form is stored as, for example forms/sign_up.liquid or
modules/<module_name>/public/forms/sign_up.liquid

redirect_to (String)

Liquid code rendering to the path or URL the user is redirected to after a successful submission

resource (String)

Kind of record the form saves, for example a table name, User or Session

resource_owner (String)

Who can submit the form: anyone or creator (anyone or self for User
forms); when anyone, protect the form with authorization policies

response_headers (String)

Liquid code rendering to a JSON object of headers added to the response of a form submission

spam_protection (SpamProtectionInput)

Captcha the submission must pass