Skip to main content
POST
Submit a public signup form

Path Parameters

publicId
string
required
Pattern: ^form_[A-Za-z0-9_-]{20,64}$

Body

Configured custom fields are accepted as additional string properties using their field keys.

email
string<email>
required
Maximum string length: 320
firstName
string
Maximum string length: 64
lastName
string
Maximum string length: 64

Required when the form configuration requires consent.

Available options:
yes,
true,
1,
on
cf-turnstile-response
string

Required when Turnstile is enabled.

Maximum string length: 2048
{key}
string
Maximum string length: 1000

Response

Submission accepted; returned for JSON clients

success
boolean
required
Example:

true

message
string
required
Example:

"You're subscribed. Thanks for joining!"

redirect
string<uri>

Present when a success redirect is configured.