Skip to main content
PATCH
Update a signup form

Authorizations

Authorization
string
header
required

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

Path Parameters

id
string<uuid>
required

Private form management identifier.

Body

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

"Website newsletter"

audienceId
string

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

Updated