Skip to main content

LeadCaptureForm

Stored in the leadcaptureforms collection. createdAt and updatedAt are maintained automatically.

Returned by DELETE /form, GET /form, POST /form, GET /form/:id, PUT /form/:id/status.

FieldTypeNotes
companyObjectId -> Companyrequired
tokenstringunique
namestringrequired
descriptionstring
statusstringdefault draft · one of draft, published, paused
templatestringrequired
formFieldsobject[]default []
formFields.fieldIdstringrequired
formFields.panelstringrequired · one of contact, lead
formFields.isCustombooleandefault false
formFields.namestringrequired
formFields.fieldTypestringrequired
formFields.valueTypestring
formFields.requiredbooleandefault false
formFields.isUniquebooleandefault false
formFields.placeholderstring
formFields.helperstring
formFields.defaultValueany
formFields.optionsobject[]default []
formFields.options.labelstring
formFields.options.descriptionstring
formFields.options.valueany
formFields.ordernumberdefault 0
settings.submitLabelstringdefault Submit
settings.successMessagestringdefault Thanks! Your response has been recorded.
settings.redirectUrlstring
settings.titlestring
settings.subtitlestring
settings.theme.primaryColorstringdefault #4f46e5
settings.theme.backgroundColorstringdefault #ffffff
settings.theme.textColorstringdefault #111827
settings.theme.borderRadiusnumberdefault 8
settings.captureUtmbooleandefault true
settings.notify.userbooleandefault false
settings.notify.adminbooleandefault false
assignment.teamObjectId -> Team
assignment.teamMemberObjectId -> Member
stats.submissionsnumberdefault 0
stats.lastSubmissionAtdate
createdByObjectId -> Member
updatedByObjectId -> Member
isDeletedbooleandefault false
_idObjectIddefault "6a95712f932657988a91c09f"
createdAtdateset once
updatedAtdate