Skip to main content
POST
Create a signup form

Authorizations

Authorization
string
header
required

API key for account management endpoints. Use your api_ prefixed token.

Body

application/json
name
string
required
Required string length: 1 - 100
Example:

"Website newsletter"

audienceId
string
required

Owned audience that successful submissions join.

status
enum<string>
default:active
Available options:
active,
paused
fields
object[]
Required array length: 1 - 20 elements
settings
object
turnstileEnabled
boolean
default:false
turnstileSiteKey
string

Cloudflare Turnstile widget site key. Required when Turnstile is enabled.

Maximum string length: 200
turnstileSecretKey
string
write-only

Cloudflare Turnstile secret. Required when enabling CAPTCHA or changing the site key.

Maximum string length: 500

Response

Created

success
boolean
required
Example:

true

id
string<uuid>
required
public_id
string
required
Example:

"form_oCiNpdGJPDhgV4kFa6t1jeoF"

form_url
string<uri>
required