Signup Forms

Partially update a signup form

Merges the given fields into the existing document - omitted fields are left unchanged. Nothing is required (unlike create) since every field is optional on a partial update.

doubleOptIn.emailId and the {{verifyLink}} content requirement are re-validated the same way as create.

patch/v1/projectId/{projectId}/signup-forms/{id}

Request

  • Base URL: https://api.bluefox.email
  • URL: https://api.bluefox.email/v1/projectId/{projectId}/signup-forms/{id}
  • Auth: HTTP bearer

Path parameters

projectIdstring required

The project _id, found in the app under Project Settings.

idstring required

Request body

namestring
publishedboolean

When true, the form is reachable at the BlueFox-hosted URL bluefox.email/signup/{slug}. Requires a slug - either set here or already on the form.

slugstring

URL-friendly identifier for the BlueFox-hosted signup page. Not generated automatically; rejected with a 400 if already taken by another form.

pageHeadlinestring

Shown as the heading on the BlueFox-hosted signup page. Falls back to the project name if not set.

pageDescriptionstring

Shown under the headline on the BlueFox-hosted signup page.

useDefaultTurnstileboolean

Defaults to true. When true, the BlueFox-hosted page (not embeds) shows and validates BlueFox's own Turnstile challenge, regardless of captchaType below - which still governs embeds, and governs the hosted page too when this is false.

subscriberListIdsstring[]
formLayoutstring
showCaptchaboolean
captchaType'none' | 'svg' | 'turnstile'
turnstileSiteKeystring
turnstileSecretKeystring

Write-only - never returned. Encrypted at rest.

turnstileTheme'light' | 'dark' | 'auto'
turnstileSize'normal' | 'compact' | 'flexible'
turnstileAppearance'always' | 'execute' | 'interaction-only'
emailPlaceholderstring
captchaPlaceholderstring
formFontStylestring
formFontColorstring
formFontSizestring
btnLabelstring
btnFontstring
btnFontColorstring
btnColorstring
btnFontSizestring
successMessagestring
successFontstring
successFontColorstring
successFontSizestring
redirectLinkstring
propertiesStyleobject

Response

OK

statusinteger

Example response

{
  "status": 200
}

Changes

No recorded changes to this operation across all 1 revision of this API.