update_form

Required. The id of the form to update. Use list_forms or get_form_details to find it.

Optional. A new name for the form. The name of the form as it will appear to users.

Optional. The word for one entry in this form, used in button labels and messages, for example ‘Artifact’. If you leave this out, Formulize works it out from the title.

Optional. The word for several entries in this form, for example ‘Artifacts’. If you leave this out, Formulize works it out from the title.

Optional. What one entry in this form represents, in plain language. An example, for a Workshop Booking form: ‘One booking, by one person, for one workshop on a given date (the workshops are entries in the Workshops form).’ This is read by AI assistants working with the form, so it should describe the meaning of an entry rather than restate the element list.

Optional. Who uses this form, when, and for what purpose. An example, for a Workshop Booking form: ‘Public users visit the form and select a workshop to book. Managers look at the bookings to make decisions about workshop scheduling and room assignments.’

Optional. Rules and expectations the data follows that are not visible in the elements themselves. An example, for a Workshop Booking form: ‘There are a limited number of spaces in a workshop, and new bookings trigger an update of the available spaces value for the selected workshop in the Workshops form. Once a workshop has no available spaces it does not show up in the bookings form anymore.’ This is often the most valuable of the three, because it describes things no amount of looking at the schema would reveal.

Optional. Keep a revision history of every change made to entries in this form. This is off by default and should only be turned on at the user’s request.

Optional. Send notification emails about activity in this form once a day as a digest, instead of immediately. This is off by default and should only be turned on at the user’s request.

Optional. The element that distinguishes one entry from another. ie: a name, an order number, etc. Not all forms have a natural principal identifier. If a form does have one, Formulize usually shows it when it needs to refer to a single entry. Give either the element’s handle or its id. To clear it, send the number 0 - that is the only value that clears it, so that leaving the setting out, or sending an empty value, cannot remove it by accident.

Optional. The screen id of the form screen that should be shown by default. When a menu item or URL leads to the form without naming a screen, and the user is limited to only interacting with a single entry in the form, Formulize will default to showing this screen. The default form screen is also used by most list screens when users click on entries to display or edit them. Send 0 to clear this setting, which means Formulize will fall back to a generic form instead, without any custom configuration settings.

Optional. The screen id of the list screen that should be shown by default. When a menu item or URL leads to the form without naming a screen, and the user has permission to interact with multiple entries in the form, Formulize will default to showing this screen. Send 0 to clear this setting, which means Formulize will fall back to a generic list instead, without any custom configuration settings.