Create Form
Create a new form
Request body
The human-readable title of the form, shown in the UI and on the hosted form page.
A URL-safe identifier used in the form's hosted URL (e.g. /forms/{slug}). Must be unique per newsletter.
Markdown body rendered above the subscribe fields on the hosted form page.
Custom CSS applied to the hosted form page.
Markdown shown to the subscriber after a successful submission.
IDs of surveys to attach to this form. Responses are associated with the submitting subscriber.
If true, the form acts as an admin-only signup form — it skips confirmation and can accept additional subscriber fields.
An enumeration.
Example request
{
"title": "Contact Form",
"slug": "contact",
"success_body": "Thank you for your submission!",
"surveys": []
}Response
Created
A unique TypeID associated with the object.
The date and time at which the object was first created.
The human-readable title of the form, shown in the UI and on the hosted form page.
A URL-safe identifier used in the form's hosted URL (e.g. /forms/{slug}). Must be unique per newsletter.
Markdown body rendered above the subscribe fields on the hosted form page.
Custom CSS applied to the hosted form page.
Markdown shown to the subscriber after a successful submission.
IDs of surveys to attach to this form. Responses are associated with the submitting subscriber.
If true, the form acts as an admin-only signup form — it skips confirmation and can accept additional subscriber fields.
An enumeration.
The number of subscribers who signed up through this form.
The number of confirmed subscribers who signed up through this form.
The number of page views for this form.