Create a signup form

Before you call

Credential

Authorization: Bearer $KEY

Scope

contacts:write

Graphql

Mutation.contactsFormCreate

Sdk

contacts.form.create

Cli

contacts form create

Request bodyapplication/json, required

• namestringrequired
  At most 120 characters.
• kindstring
  One of: signup, lead, preference, contact, support, enquiry, comment. Default: signup.
• titlestring
  At most 200 characters.
• introstring
  At most 1000 characters.
• submitLabelstring
  At most 40 characters.
• fieldslist of objectrequired
  • keystringrequired
    Pattern: ^[a-z][a-z0-9_]{0,39}$.
  • labelstringrequired
    At most 120 characters.
  • typestringrequired
    One of: text, email, phone, textarea, select, checkbox, hidden.
  • requiredboolean
  • optionslist of string
  • mapsstring
    Pattern: ^(name|firstName|lastName|email|phone|country|language|company|custom.[a-z][a-z0-9_]{0,39})$.
• consentslist of object
  Default: [].
  • channelstringrequired
    One of: email, sms, whatsapp, phone.
  • purposestring
    Default: marketing. Pattern: ^[a-z][a-z0-9_]{0,29}$.
  • textstringrequired
    At most 600 characters.
  • requiredboolean
• optInstring
  One of: double, single. Default: double.
• tagslist of string
• lifecyclestring
  One of: subscriber, lead, customer, partner, other.
• policyVersionstring
  At most 40 characters.
• policyUrlstring (uri)
  At most 300 characters.
• successMessagestring
  At most 300 characters.
• redirectUrlstring (uri)
  At most 300 characters.
• allowedOriginslist of string
• leadMagnetobject
  • assetIdstring (uuid)
  • urlstring (uri)
    At most 500 characters.
  • labelstring
    At most 80 characters.
• widgetstring
  One of: email_signup, newsletter, waitlist, contact, lead_form.
• defaultLanguagestring
  Default: en. Pattern: ^[a-z]{2}(-[A-Za-z]{2})?$.
• copyobject
• designobject
  • themestring
    One of: auto, light, dark. Default: auto.
  • sizestring
    One of: compact, regular, large. Default: regular.
  • accentstring
    Pattern: ^#[0-9a-f]{6}$.
  • radiusinteger
    At least 0. At most 32.
  • fontstring
    One of: inherit, system. Default: inherit.
• destinationobject
  • inboxIdstring (uuid)
• routelist of object
  • fieldstring
    At most 60 characters.
  • containsstring
    At most 120 characters.
  • languagestring
    At most 20 characters.
  • inboxIdstring (uuid)required
• autoConfirmboolean
  Default: true.
• guardobject
  • enabledboolean
    Default: true.
• activeboolean
  Default: true.
• pageobject
  • headlinestring
    At most 200 characters.
  • bodystring
    At most 4000 characters.
  • accentstring
    Pattern: ^#[0-9a-f]{6}$.

Responses

• 201application/json
  Success

  object

• 400application/json
  The request was malformed
  • errorstringrequired
  • messagestring
• 401application/json
  No valid credential
  • errorstringrequired
  • messagestring
• 403application/json
  The credential lacks the scope, origin or address
  • errorstringrequired
  • messagestring
• 429application/json
  Over the key's rate limit; see Retry-After
  • errorstringrequired
  • messagestring