Generic form pages and event pages. Changes only the keys you send; a key you leave out keeps its value.
title and description take a string for the page's first language, or an object of { language_code: text } for the languages in supported_languages. A language that is not in supported_languages is refused. An empty string clears the text of one language. Script, frames, and event handler attributes in description are refused, so text that holds them returns 422. image_url is an https URL of at most 2,048 characters; null or an empty string removes the image.
Event pages: title, description, image_url, name, and published can change. The page of an event is event_page_id in GET /events/{id}, and the event's description and image_url in that response come from this page. The form of an event page is its RSVP form and changes in the dashboard, so fields, renames, and confirm_removals return 409. Co-host organizations keep their own copy of an event page, and this call does not change it. To take down the page of a deleted event, send published: false.
fields is the whole ordered list: a field you leave out is removed. A field you send keeps every form builder setting the API does not name. A field cannot change type. To rename a field and keep its submissions, send it under the new name and add { old_name: new_name } to renames; migrated reports how many submissions moved.
A change that removes a field or an option that already has submissions returns 409 with requires_confirmation and impacts (each removed field or option and its submission count). Send the same request with confirm_removals: true to save it. This is the same check the form builder makes before it saves.
Custom property fields are { property, label, required }, as in POST. They keep their names and cannot be renamed. Their options always follow the property.
A field read from GET can be sent back unchanged, so a client can read fields, change one entry, and send the whole list.
Forms with parts the API cannot describe (HTML blocks, subforms, conditional fields, builder only field types) return fields: null in GET and refuse a fields change with 409; name, title, description, image_url, and published still change. Pages that are neither generic forms nor event pages return 409.
The admin who created the API key must have the pages.manage permission in the page's scope.
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
