Creates a form page

Creates a generic form page from an ordered list of fields. Each field becomes the component the form builder makes for its type, so the page edits normally in the dashboard afterwards.

The form must include an email or phone_number field with required: true; that is how a submission is matched to a person. Submissions can then be imported with POST /user_actions using the page id; the answer keys are the field names.

Page names are unique per website (case insensitive). A duplicate name returns 409 with existing_page_id. Without url_slug the slug comes from the name. website_id is required when the scope can use more than one website; each page in GET /pages carries its website_id.

A custom property field is { property, label, required }, where property is the internal_name from GET /custom_user_properties. Its answer saves onto the person. Its type comes from the property, and its options always follow the property. To use a new property, create it first with POST /custom_user_properties.

The API key writes for the admin who created it. That admin must have the pages.manage permission in the page's scope. The Zapier key cannot create pages.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
enum

Owner of the new page. Defaults to the API key organization.

Allowed:
integer
Body Params
string
required

Page name. Also the default title and slug.

Headline on the page. Defaults to name.

HTML shown above the form. Script is refused.

integer
string

Lowercase letters, digits, -, _, and /. A taken or reserved slug is refused.

string
enum
Defaults to full_page
Allowed:
boolean
Defaults to true
fields
array of objects
required
fields*
Responses

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json